package
0.0.0-20180911130330-d3ccc4fb1d66
Repository: https://github.com/rglyons/kube-arangodb.git
Documentation: pkg.go.dev
# Functions
DurationOrDefault returns the default value (or empty string) if input is nil, otherwise returns the referenced value.
EnvironmentOrDefault returns the default value (or empty string) if input is nil, otherwise returns the referenced value.
ExternalAccessTypeOrDefault returns the default value (or empty string) if input is nil, otherwise returns the referenced value.
IsAlreadyExists return true when the given error is or is caused by a AlreadyExistsError.
IsNotFound return true when the given error is or is caused by a NotFoundError.
IsValidation return true when the given error is or is caused by a ValidationError.
ModeOrDefault returns the default value (or empty string) if input is nil, otherwise returns the referenced value.
NewAction instantiates a new Action.
NewDuration returns a reference to a Duration with given value.
NewDurationOrNil returns nil if input is nil, otherwise returns a clone of the given value.
NewEnvironment returns a reference to a string with given value.
NewEnvironmentOrNil returns nil if input is nil, otherwise returns a clone of the given value.
NewExternalAccessType returns a reference to a string with given value.
NewExternalAccessTypeOrNil returns nil if input is nil, otherwise returns a clone of the given value.
NewMode returns a reference to a string with given value.
NewModeOrNil returns nil if input is nil, otherwise returns a clone of the given value.
NewPercent returns a reference to a percent with given value.
NewPercentOrNil returns nil if input is nil, otherwise returns a clone of the given value.
NewStorageEngine returns a reference to a string with given value.
NewStorageEngineOrNil returns nil if input is nil, otherwise returns a clone of the given value.
PercentOrDefault returns the default value or 0 if input is nil, otherwise returns the referenced value.
Resource gets an ArangoCluster GroupResource for a specified resource.
StorageEngineOrDefault returns the default value (or empty string) if input is nil, otherwise returns the referenced value.
# Constants
ActionTypeAddMember causes a member to be added.
ActionTypeCleanOutMember causes a member to be cleaned out (dbserver only).
ActionTypeRemoveMember causes a member to be removed.
ActionTypeRenewTLSCACertificate causes the TLS CA certificate of the entire deployment to be renewed.
ActionTypeRenewTLSCertificate causes the TLS certificate of a member to be renewed.
ActionTypeRotateMember causes a member to be shutdown and have it's pod removed.
ActionTypeSetCurrentImage causes status.CurrentImage to be updated to the image given in the action.
ActionTypeShutdownMember causes a member to be shutdown and removed from the cluster.
ActionTypeUpgradeMember causes a member to be shutdown and have it's pod removed, restarted with AutoUpgrade option, waited until termination and the restarted again.
ActionTypeWaitForMemberUp causes the plan to wait until the member is considered "up".
No description provided by the author
No description provided by the author
CASecretNameDisabled is the value of CASecretName to use for disabling authentication.
ConditionTypeAgentRecoveryNeeded indicates that the member (agent) will no longer recover from its current volume and there has to be rebuild using the recovery procedure.
ConditionTypeAutoUpgrade indicates that the member has to be started with `--database.auto-upgrade` once.
ConditionTypeCleanedOut indicates that the member (dbserver) has been cleaned out.
ConditionTypeMemberOfCluster indicates that the member is a known member of the ArangoDB cluster.
ConditionTypePodSchedulingFailure indicates that one or more pods belonging to the deployment cannot be schedule.
ConditionTypeReady indicates that the member or entire deployment is ready and running normally.
ConditionTypeSecretsChanged indicates that the value of one of more secrets used by the deployment have changed.
ConditionTypeTerminated indicates that the member has terminated and will not restart.
DeploymentModeActiveFailover yields an agency and a active-failover server pair.
DeploymentModeCluster yields an full cluster (agency, dbservers & coordinators).
DeploymentModeSingle yields a single server.
DeploymentPhaseFailed indicates that a deployment is in a failed state from which automatic recovery is impossible.
DeploymentPhaseNone indicates that the phase is not set yet.
DeploymentPhaseRunning indicates that the deployment is under control of the ArangoDeployment operator.
EnvironmentDevelopment yields a cluster optimized for development.
EnvironmentProduction yields a cluster optimized for production.
ExternalAccessTypeAuto yields a cluster with an automatic selection for external access.
ExternalAccessTypeLoadBalancer yields a cluster with a service of type `LoadBalancer` to provide external access.
ExternalAccessTypeNodePort yields a cluster with a service of type `NodePort` to provide external access.
ExternalAccessTypeNone yields a cluster with no external access.
JWTSecretNameDisabled is the value of JWTSecretName to use for disabling authentication.
MemberIDPreviousAction is used for Action.MemberID when the MemberID should be derived from the previous action.
MemberPhaseCleanOut indicates that a dbserver is in the process of being cleaned out.
MemberPhaseCreated indicates that all resources needed for the member have been created.
MemberPhaseFailed indicates that the member is gone beyond hope of recovery.
MemberPhaseNone indicates that the state is not set yet.
MemberPhaseRotating indicates that a member is being rotated.
MemberPhaseShuttingDown indicates that a member is shutting down.
MemberPhaseUpgrading indicates that a member is in the process of upgrading its database data format.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StorageEngineMMFiles yields a cluster using the mmfiles storage engine.
StorageEngineRocksDB yields a cluster using the rocksdb storage engine.
# Variables
No description provided by the author
AllServerGroups contains a constant list of all known server groups.
AlreadyExistsError indicates an object that already exists.
No description provided by the author
No description provided by the author
NotFoundError indicates an object that cannot be found.
No description provided by the author
No description provided by the author
ValidationError indicates a validation failure.
# Structs
Action represents a single action to be taken to update a deployment.
ArangoDeployment contains the entire Kubernetes info for an ArangoDB database deployment.
ArangoDeploymentList is a list of ArangoDB clusters.
AuthenticationSpec holds authentication specific configuration settings.
ChaosSpec holds configuration for the deployment chaos monkey.
Condition represents one current condition of a deployment or deployment member.
DeploymentSpec contains the spec part of a ArangoDeployment resource.
DeploymentStatus contains the status part of a Cluster resource.
DeploymentStatusMembers holds the member status of all server groups.
ExternalAccessSpec holds configuration for the external access provided for the deployment.
ImageInfo contains an ID of an image and the ArangoDB version inside the image.
MemberStatus holds the current status of a single member (server).
MonitoringSpec holds monitoring specific configuration settings.
RocksDBEncryptionSpec holds rocksdb encryption at rest specific configuration settings.
RocksDBSpec holds rocksdb specific configuration settings.
SecretHashes keeps track of the value of secrets so we can detect changes.
ServerGroupSpec contains the specification for all servers in a specific group (e.g.
SyncAuthenticationSpec holds dc2dc sync authentication specific configuration settings.
SyncExternalAccessSpec holds configuration for the external access provided for the sync deployment.
SyncSpec holds dc2dc replication specific configuration settings.
TLSSpec holds TLS specific configuration settings.
# Type aliases
ActionType is a strongly typed name for a plan action item.
ConditionList is a list of conditions.
ConditionType is a strongly typed condition name.
DeploymentMode specifies the type of ArangoDB deployment to create.
DeploymentPhase is a strongly typed lifetime phase of a deployment.
Duration is a period of time, specified in go time.Duration format.
Environment in which to run the cluster.
ExternalAccessType specifies the type of external access provides for the deployment.
ImageInfoList is a list of image infos.
MemberPhase is a strongly typed lifetime phase of a deployment member.
MemberStatusList is a list of MemberStatus entries.
Percent is a percentage between 0 and 100.
Plan is a list of actions that will be taken to update a deployment.
No description provided by the author
StorageEngine specifies the type of storage engine used by the cluster.