package
0.0.0-20230628214157-3bfe64699e82
Repository: https://github.com/gravitational/gravity.git
Documentation: pkg.go.dev
# Functions
AlternateBinPath returns a path in the alternative binary directory for the specifies sub-paths.
DockerRegistryAddr returns the address of docker registry running on server.
FormatKubernetesNodeRoleLabel formats the provided gravity role name as a kubernetes node role label as shown in `kubectl get nodes`.
GravityRPCAgentAddr returns default RPC agent advertise address.
HookSecurityContext returns default securityContext for hook pods.
InGravity builds a directory path within gravity working directory.
InstallerAddr returns the complete address of the installer given its IP.
InSystemUnitDir returns the path of the user service given with serviceName.
InTempDir returns the specified subpath inside default tmp directory.
ParseReconcileMode parses the value to determine the reconciliation mode.
Secret returns full path to the specified secret file.
SystemUnitPath builds the path to the specified unit in the system unit directory.
TLSConfig returns default TLS configuration.
WithTimeout returns a default timeout context.
# Constants
AbortedOperationExitCode specifies the exit code for this process when an operation is aborted.
AgentConnectTimeout specifies the timeout for the initial connect.
AgentDeployTimeout specifies the maximum amount of time to wait to deploy agents for an operation that spans multiple nodes Note: Needs to be above 5 minutes or timeouts can occur on 1k node clusters.
AgentDir is the gravity subdirectory where update agent stores its data.
AgentGroupPeerReconnectTimeout is the maximum amount of time agent group will attempt to reconnect to the peer.
AgentHealthCheckTimeout specifies the maximum amount of time for a health check.
AgentReconnectTimeout specifies the timeout for attempt to reconnect.
AgentRequestTimeout defines the maximum amount of time an agent is blocked on a request.
AgentStopTimeout is amount of time agent gets to gracefully shut down.
AgentTokenBytes is a default length in bytes of random auth token generated for agent.
AgentValidationTimeout specifies the maximum amount of time for a remote validation request during the preflight test.
AgentWaitTimeout specifies the maximum amount of time to wait for agents to form a cluster before commencing the operation.
AlertmanagerServicePort is the Alertmanage service port.
AlternativeBinDir defines the default location for binaries on Ubuntu Core.
APIPrefix defines the URL prefix for kubernetes-related queries tunneled from a master node.
APIServerSecurePort is api server secure port.
APIVersion is a current version of APIs.
APIWaitTimeout specifies the maximum amount of time to wait for API call to succeed.
App defines the application to create if not specified.
ApplicationLabel defines the label used to annotate kubernetes resources to group them together.
AppSyncInterval is how often app images are synced with the local registry.
ArchiveGID specifies the group ID to use for tarball items that do not exist on disk.
ArchiveUID specifies the user ID to use for tarball items that do not exist on disk.
AuditLogClientTimeout specifies the timeout for collecting audit logs.
AWSRegion is the default AWS region.
AWSSubnetCIDR is the default AWS subnet CIDR.
AWSVPCCIDR is the default AWS VPC CIDR.
BackupDir is the directory where some operations store backup data.
BandwagonPackageName is the name of bandwagon app package.
BandwagonServiceName is the name of the default setup endpoint service.
100GB.
BandwidthTestDuration is the duration of a bandwidth test agents do.
BandwidthTestMaxServers is the maximum amount of servers participating in the bandwidth test.
BandwidthTestPort is the port for the bandwidth test agents do.
20 years.
CertBackdating is the time duration that will be used to shift back the start date of the certificate validity period.
10 years.
CertRenewBeforeExpiry is the time window to replace a certificate before expiration.
CertRenewPeriod is how often the certificate is renewed.
CertsDir is where all certificates are stored on the host machine.
CertTTL is Teleport's SSH cert default TTL.
CheckForUpdatesInterval is how often local gravity site will attempt to check for new app versions with OpsCenter.
ClientCacheSize is the size of the RPC clients expiring cache.
ClientCacheTTL is ttl for clients cache expiration.
ClusterCheckTimeout is amount of time allotted to the test that verifies if cluster controller is accessible.
ClusterStatusTimeout specifies the time limit for cluster status check.
CompletedOperationExitCode specifies the exit code for this process when an operation completes successfully.
ConnectionDeadlineTimeout specifies the connection deadline timeout for use with the vhost muxer.
ConnectionIdleTimeout is a default connection timeout used to extend idle connection deadline.
ContainerEnvironmentFile specifies the location of the file for container environment.
ContainerFileLabel specifies the default SELinux container file label.
DatabaseSchemaVersion is a running counter for the current version of the database schema.
DBOpenTimeout is a default timeout for opening the DB.
DebugReportFile specifies the name of the file with diagnostics information.
DecoderBufferSize is the size of the buffer used when decoding YAML resources.
DevicemapperAutoextendStep defines the devicemapper extension step in percent.
DevicemapperAutoextendThreshold is the percentage of space used before LVM automatically attempts to extend the available space (100=disabled).
DialTimeout is a default TCP dial timeout we set for our connection attempts.
DiscoveryPublishInterval specifies the frequency to publish changes cluster discovery details.
DiscoveryResyncInterval specifies the frequency to force publish cluster discovery details.
DiskCapacity is the minimum required free disk space for some default directories.
DiskTestDuration is the duration of the disk performance test.
DiskTransferRate is the minimum required disk speed for some default locations.
DistributionOpsCenter is the address of OpsCenter used for distributing dependencies for app builds.
DistributionOpsCenterName is the name of the distribution Ops Center.
DistributionOpsCenterPassword is the password for the distribution OpsCenter user.
DistributionOpsCenterUsername is the read-only disribution OpsCenter username.
DNSListenAddr is the default address coredns will be configured to listen on.
DNSPort is the default DNS port coredns will be configured with.
DockerBridge specifies the default name of the docker bridge.
DockerCertsDir is the directory where Docker looks for certs.
DockerDeviceCapacity defines the baseline size for the docker devicemapper device used by default if no backend and no size has been explicitly specified.
DockerRegistryPort is the default port for connecting to private docker registries.
DownloadRetryAttempts is the number of attempts to download package/file before giving up.
DownloadRetryPeriod is the period between failed retry attempts.
DrainErrorTimeout specifies the timeout for the initial failures of drain operation.
DrainTimeout defines the total drain operation timeout.
ElectionTerm is a leader election term for multiple gravity instances.
ElectionWaitTimeout specifies the maximum amount of time to wait to resume elections on a master node.
EndpointsWaitTimeout specifies the timeout for waiting for system service endpoints.
EnvironmentPath is the path to the environment file.
EtcdAPILegacyPort is the legacy etcd client API port.
EtcdAPIPort is the etcd client API port.
EtcdCertFilename is the etcd certificate filename.
EtcdCtlBin is /usr/bin/etcdctl.
EtcdDir is the name of the etcd directory.
EtcdGravityPrefix is etcd prefix under which gravity keeps its data.
EtcDir is the /etc directory on host.
EtcdKey is the key under which gravity data is stored in etcd.
EtcdKeyFilename is the etcd private key filename.
EtcdLocalAddr is the local etcd address.
EtcdPeerLegacyPort is the legacy etcd inter-cluster communication port.
EtcdPeerPort is the etcd inter-cluster communication port.
EtcdPlanetPrefix is etcd prefix under which planet keeps its data.
EtcdRemoveMemberTimeout specifies the maximum amount of time to wait for member removal.
EtcdRetryInterval is the retry interval for some etcd commands.
EtcdUpgradeBackupFile is the filename to store a temporary backup of the etcd database when recreating the etcd datastore.
EtcWritableDir is the /etc/writable directory on host (e.g.
ExpandTokenTTL is used for temporary provisioning tokens created during expand operations.
ExponentialRetryInitialDelay is the interval between the first and second retry attempts.
ExponentialRetryMaxDelay is the maximum delay between retry attempts.
FailedPreconditionExitCode specifies the exit code to indicate a precondition failure.
FetchLimit is a default fetch limit for range objects.
GCPeriod sets default garbage collection period.
GracePeriod is a period for GC not to delete undetected files to prevent accidental deletion.
GrafanaServiceName is the name of Grafana service.
GrafanaServicePort is the port Grafana service is listening on.
GravityAgentBin specifies the location of the gravity binary used during upgrades.
GravityBin is a default location of gravity binary.
GravityBinAlternate is an alternative location of gravity binary on systems where /usr/bin is not writable (e.g.
GravityClusterLabel defines the label to select cluster controller Pods.
GravityConfigFilename is the name of the file with gravity configuration.
GravityDBFile is a default file name for gravity sqlite DB file.
GravityDir is where all root state of Gravity is stored.
GravityDisplayName is the display-friendly name of the base image.
GravityEphemeralDir was used by prior versions to store short-lived data.
GravityFileLabel specifies the file label for the gravity binary.
GravityHubDisplayName is the display-friendly name of the Hub image.
GravityInstallerProcessLabel specifies the SELinux label of the installer process.
GravityListenPort is the port number where gravity process serves its API.
GravityLocalAgentBin specifies the path to the gravity binary used in interactive installation.
GravityMountService defines the name of the service for the gravity state directory to handle filesystem mounts Important: keep this mount service in sync with the value of GravityDir Source: https://www.freedesktop.org/software/systemd/man/systemd.mount.html.
GravityOpsCenterLabel defines the label for Ops Center related resources.
GravityPackagePrefix defines base prefix of gravity package.
GravityPublicListenPort is the port number where gravity process serves user traffic (such as UI and web API) if it's separated in Ops Center mode.
GravityRPCAgentPort defines which port RPC agent is listening on.
GravityRPCAgentServiceName defines systemd unit service name for RPC agents.
GravityRPCInstallerServiceName defines systemd unit service name for the installer.
GravityRPCInstallerSocketName defines the name of the socket file for the installer service.
GravityRPCResumeServiceName defines systemd unit service name for resuming the operation plan.
GravitySELinuxEnv defines the environment variable that controls whether to use SELinux.
GravityServiceHost defines the address internal gravity site is located at.
GravityServiceHostEnv defines the gravity service host in environment.
GravityServicePort defines the address internal gravity site is located at.
GravityServicePortEnv defines the gravity service port in environment.
GravitySiteAuthNodePort is the node port where gravity-site exposes teleport auth service.
GravitySiteNodePort is a default site NodePort load balancer port.
GravitySystemLogFile is the system log file name.
GravityUpdateDir specifies the directory used by the update process.
GravityUserLogFile is the user log file name.
GravityWebAssetsDir is the directory where gravity stores assets (including web) depending on the work mode.
GravityYAMLFile is a default filename for gravity config file.
GroupReadMask is a mask with group read access.
HealthListenAddr is a default healthcheck address.
HeartbeatPeriod specifies default heartbeat period.
Helm3Bin is the location of helm 3 binary inside planet.
Helm3BinAlternate is the alternative location of helm 3 symlink on systems where /usr/bin is not writable.
Helm3Script is the location of the helm 3 script, which the host's helm is symlinked to, inside the planet.
HelmBin is the location of helm binary inside planet.
HelmBinAlternate is the alternative location of helm symlink on systems where /usr/bin is not writable.
HelmScript is the location of the helm script, which the host's helm is symlinked to, inside the planet.
HomeDir is the default home dir.
HookContainerNameTag identifies the container image used for application hooks.
HookJobDeadline sets the default limit on the hook job running time.
HostBin is the /usr/bin directory on host.
HOTPFirstTokensRange is amount of lookahead tokens we remember for sync purposes.
HOTPTokenDigits is the amount of digits in HOTP token.
HTTPSPort is a default HTTPS port.
HubAddress is the address of the open-source Hub.
HubBucket is the name of S3 bucket that stores binaries and artifacts.
HubTelekubePrefix is key prefix under which Telekube artifacts are stored.
HumanReasonableTimeout is amount of time certain command can run without producing any output.
ImageRegistryVar is a local cluster registry variable that gets substituted in Helm templates.
ImageServiceMaxThreads specifies the concurrency limit for I/O operations of the distribution local filesystem driver.
ImportDir is the place for app import state.
IngressAppName is the name of the ingress application.
1.5 hours.
InstallerDBFile is a default file name for the installer state database file.
InstallGroupTTL is for how long installer IP is kept in a TTL map in an install group.
InstallSystemServiceTimeout specifies the maximum time to wait for system install service to complete.
InstallTokenBytes is the length of the token generated for a one-time installation.
InstallTokenTTL is the TTL for the install token after the installation has been completed/or failed.
InstanceTerminationTimeout is the maximum amount of time to wait for AWS EC2 instance to terminate.
JournalctlBin is the default location of the journalctl inside planet.
JournalctlBinHost is the default location of the journalctl on host.
KeepAliveTimeout tells for how long keep the connection alive with no activity.
KubeConfigDir is a default directory where k8s stores its user local config.
KubeConfigFile is a default filename where k8s stores its user local config.
KubectlBin is the default location of kubectl binary.
KubectlBinAlternate is an alternative location of kubectl binary on systems where /usr/bin is not writable (e.g.
KubectlScript is the location of kubectl script, which host's kubectl is symlinked to, inside the planet.
KubeDNSLabel defines the label to select cluster DNS service Pods.
KubeDNSWorkerLabel defines a label to select cluster DNS services on worker nodes.
KubeForwarderUser is the identity used to generate a certificate for access to kubernetes API server on secure port.
KubeletCertFilename is the kubelet certificate filename.
KubeletKeyFilename is the kubelet private key filename.
KubeletUpdatePermissionsRole defines the names of clusterrole/clusterrolebinding for kubelet used to add missing permissions during upgrade of the first master node.
KubeletURL defines the default address of the local instance of the k8s kubelet.
KubernetesAdvertiseIPLabel is the kubernetes node label of the advertise IP address.
KubernetesReconcileLabel is the kubernetes node label to define the reconcile mode, which controls the reconciliation process for the node labels.
KubernetesRoleLabel is the Kubernetes node label with system role.
KubeSystemNamespace is the name of k8s namespace where all our system stuff goes.
LabelRetryAttempts specifies the maximum number of attempts to label a node.
LBIdleTimeout is the idle timeout for AWS load balancers.
LicenseCheckInterval is how often local gravity site will check the installed license.
LocalAgentsAddr is address of the local server that serves cluster traffic behind SNI router.
LocalConfigDir is a default directory where gravity stores its user local config.
LocalConfigFile is a default filename where gravity stores its user local config.
LocalDataDir is a default directory where gravity stores its local data.
LocalDir is the gravity subdirectory where local data is stored.
LocalGravityDir is the path to local gravity package state.
LocalPublicAddr is address of the local server that serves user traffic behind SNI router.
LocalResolverAddr is address of local DNS resolver.
LogDir is the name of the log directory.
LogForwardersConfigMap is the name of the config map that contains log forwarders configuration.
LoggingAppName is the name of the logging application.
LograngeAggregatorServiceName is the name of the Logrange aggregator service.
LogServiceAPIVersion defines the current version of the log service API.
LogServiceName defines the name the internal logging service is accessible on.
LogServicePort defines the port the logging service is listening on.
LogServicePrefix defines the URL prefix for the internal log tailing and configuration service tunneled from a master node.
ManifestFileName is the name of the application manifest.
MaxIdleConnsPerHost specifies the max amount of idle HTTP connections to keep.
MaxMasterNodes defines the maximum number of master nodes in the cluster.
MaxOperationConcurrency defines a number of servers an operation can run on concurrently.
MaxOutOfSyncTimeDelta allows maximum out of sync time.
MaxPasswordLength is maximum password length (for sanity).
MaxRouterIdleConnsPerHost defines tha maximum number of idle connections for "opsroute" transport.
MaxSignupTokenTTL is a maximum TTL for a web signup one time token clients can reduce this time, not increase it.
MaxSiteLabelKeyLength is the maximum length of a label key.
MaxSiteLabels is the maximum number of labels allowed per site.
MaxSiteLabelValLength is the maximum length of a label value.
MaxUserResetTokenTTL is a maximum TTL for password reset token.
MaxValidationConcurrency defines a number of validation requests to run concurrently.
MetricsInterval is the default interval cluster metrics are displayed for.
MetricsStep is the default interval b/w cluster metrics data points.
MinPasswordLength is minimum password length.
MissedHeartbeats is the amount of missed heartbeats that will be considered as node failure.
ModulesPath is the path to the list of gravity-specific kernel modules loaded at boot.
MonitoringAppName is the name of the monitoring application.
MonitoringNamespace is the name of k8s namespace for the monitoring-related resources.
Namespace is a default namespace.
NodeLabelsReconcileInterval is how often node labels reconciler runs.
NodeLeaveTimeout specifies the maximum amount of time to wait for node to leave the cluster.
NodeStatusTimeout specifies the maximum amount of time to wait for healthy node status.
OfflineCheckInterval is how often OpsCenter checks whether its sites are online/offline.
OIDCCallbackTimeout is timeout waiting for OIDC callback.
OIDCConnectorID is a default OIDC connector to use.
OpenEBSNamespace is the name of k8s namespace where OpenEBS is deployed.
OpsCenterPackage is the Ops Center cluster image name.
PackagesDir is the place where we put all local packages.
PathEnv is a name for standard linux path environment variable.
PathEnvVal is a default value for PATH environment variable.
PeerConnectTimeout is the timeout of an RPC agent connecting to its peer.
PeriodicUpdatesInterval is the default periodic updates check interval.
PeriodicUpdatesMinInterval is the minimum allowed interval for periodic updates checks.
PeriodicUpdatesTickInterval is the periodic updates ticker interval.
PhaseTimeout is the default phase execution timeout.
PingPongDuration is the duration of a ping-pong game agents play.
PlaceholderGroupID is a placeholder for a real group ID Used to differentiate a valid ID from an empty value.
PlaceholderUserID is a placeholder for a real user ID.
PlanetBin is the default location of planet binary.
PlanetCredDir specifies the planet certs and keys directory.
PlanetDir is the name of the planet directory.
PlanetKubeConfigPath is the location of kube config inside planet's filesystem.
PlanetSELinuxEnv defines the planet selinux state marker in environment.
PlanetShareDir is the in-planet share directory.
PlanetStateDir specifies the location of planet runc-specific state.
PodSubnet is a subnet dedicated to the pods in the cluster.
PreflightChecksTimeout is the timeout for preflight checks.
PrivateDirMask is a mask for private directories.
PrivateExecutableFileMask is a mask for private binaries.
PrivateFileMask is a mask for private files.
ProfilingInterval defines the frequency of taking state snapshots (debugging).
ProgressPollTimeout defines the timeout between progress polling attempts.
PrometheusServiceAddr is the Prometheus HTTP API service address.
ProvisioningTokenBytes is the length of the provisioning token generated during installs.
ProvisionRetryAttempts is the number of provisioning attempts.
ProvisionRetryInterval is the interval between provisioning attempts.
ReadHeadersTimeout is a default TCP timeout when we wait for the response headers to arrive.
ReconcileModeDisabled disables reconciliation.
ReconcileModeEnabled enables full reconciliation.
ReconcileModeEnsureExists describes a label reconciliation mode when the labels will only be checked for existence.
RegistryCAFilename is filename of cluster Docker registry CA certificate.
RegistryCertFilename is filename of cluster Docker registry certificate.
RegistryDir is the name of the layers directory inside an application tarball.
RegistryKeyFilename is filename of cluster Docker registry private key.
RegistrySyncInterval is how often cluster images are synced with the local registry.
RemoteClusterDialAddr is the "from" address used when dialing remote cluster.
ReportTarball is the name of the gzipped tarball with collected site report information.
ResetPasswordLength is the length of the reset user password.
ResourceGracePeriod forces a kubernetes operation to use the default grace period defined for a resource.
ResourcesDir is the name of the directory where apps store their resources such as app manifest.
ResourcesFile is the default name of the file with application k8s resources.
ResumeRetryAttempts specifies the total number of attempts to resume last operation.
ResumeRetryInterval specifies the frequency of attempts to resume last operation.
RetryAttempts is the total number of attempts.
RetryInterval is the interval between retry attempts.
RetryLessAttempts is the total number of attempts in retry scenario with a smaller wait window.
RetrySmallerMaxInterval is the total time for the retry scenario with a smaller wait window.
RoleMaster is the master nodes label.
RootCertFilename is the certificate authority certificate filename.
RootfsDir is the common rootfs directory name.
RPCAgentBackoffThreshold defines max communication delay before retrying connection to remote agent node.
RPCAgentSecretsPackage specifies the name of the RPC credentials package.
RSAPrivateKeyBits is default bits for RSA private key.
RunLevelLabel is the Kubernetes node taint label representing a run-level.
RunLevelSystem is the Kubernetes run-level for system applications.
Runtime is the name of default runtime application.
SatelliteMetricsPort is port used by satellite agent to expose metrics.
SatelliteRPCAgentPort is port used by satellite agent to expose its status.
SchedulerCertFilename is the kube-scheduler certificate filename.
SchedulerKeyFilename is the kube-scheduler private key filename.
SecretsDir is the place for gravity TLS secrets to be.
SelfSignedCertWebOrg is the Organization that is used to self-sign certificates.
ServiceAddrSuffix is the DNS name suffix appended to service addresses.
ServiceConnectTimeout specifies the timeout for connecting to the installer service.
ServiceGID is a numeric default service group ID.
ServiceGroupID specifies the ID of the service group created by default.
ServiceSubnet is a subnet dedicated to the services in cluster Notes on 100.64.0.0/10 - https://tools.ietf.org/html/rfc6598
We're sort of abusing rfc6598 here, since the intended purpose of this range is specifically for carrier grade NAT.
ServiceUID is a numeric default service user ID.
ServiceUser specifies the name of the user used as a service user in planet as well as for unprivileged (system) kubernetes resources.
ServiceUserGroup specifies the name of the user group used for a service user in planet.
ServiceUserID specifies the ID of the service user created by default.
SharedDirMask is a mask for shared directories.
SharedExecutableMask is a mask for shared executable file.
ShareDir is the name of the share directory.
SharedReadMask is a mask for a shared file with read access for everyone.
SharedReadWriteMask is a mask for a shared file with read/write access for everyone.
ShrinkAgentServiceName specifies the name of the systemd unit file that executes a shrink agent on a remote node.
ShutdownTimeout specifies the maximum amount of time to wait for completion when closing.
SignupTokenBytes is length in bytes for crypto random generated signup tokens.
SignupTokenTTL is a default signup token expiry time.
SiteDir is the gravity subdirectory where cluster data is stored.
SiteDomainName is used by site create tool.
SiteStatusCheckInterval is how often local gravity site will invoke app status hook.
SMTPPort defines the SMTP service port.
SourceDestinationCheckInterval is how often Gravity will check if any of the instances have source/dest check enabled and try to disable it.
SSHDir is the .ssh directory.
SSHInstallPort is default port for SSH install agents.
SSHUser is a default user used in SSH sessions TODO(klizhentas) what user to choose, this should be site-specific and use principle of least privilege.
StatBin is stat executable path inside planet.
StateRegistryDir is the name of the docker registry directory inside the planet state directory.
StateSyncInterval is how often cluster state is synced to the local backend.
StatusCollectionTimeout specifies the timeout for collecting gravity status.
StorageAppName is the name of the gravity application with OpenEBS.
SysctlPath is the path to gravity-specific kernel parameters configuration.
SystemAccountID is the ID of the system account.
SystemAccountOrg is the default name of Gravitational organization.
SystemctlBin is systemctl executable inside planet.
SystemdLogDir specifies the default location of the systemd journal files.
SystemdMachineIDFile specifies the default location of the systemd machine-id file.
SystemdTasksMinVersion is the version of systemd that added support for TasksMax setting.
SystemLogDir is the directory where gravity logs go.
SystemServiceRestartSec is a default restart period for system services installed by gravity.
SystemServiceTasksMax is a default amount of tasks allowed in systemd unit.
SystemServiceWantedBy sets default target for system services installed by gravity.
SystemUnitDir specifies the location of user-specific service units.
TctlBin is the default location of tctl binary.
TctlBinAlternate is the alternative location of tctl binary on systems where /usr/bin/ is not writable.
TelekubePackage is the Telekube cluster image name.
TeleportCommandLabelInterval is the interval for teleport command labels.
TeleportDir is the gravity subdirectory where teleport data is stored.
TeleportPublicIPv4Label is the name of teleport command label containing server's public IP.
TeleportServerQueryTimeout specifies the maximum amount of time allotted to query teleport servers.
TeleportYAMLFile is a default filename for teleport config file.
TerminationWaitTimeout defines an amount of time above the Kubernetes TerminationGracePeriod to wait for a pod to be terminated.
TestETCD instructs us to test Etcd backend.
TestETCDConfig is a JSON BLOB with etcd config.
TestK8s controls whether k8s tests are run.
TestPostgres environment variable turns on or off PostgreSQL tests.
TestPostgresURI is a test URI connector for PostgreSQL tests.
TillerAppName is the name of the tiller application.
TransientErrorTimeout specifies the maximum amount of time to attempt an operation experiencing transient errors.
UnpackedDir is the default named of the directory with unpacked package archives.
UpdateAppSyncTimeout defines the maximum amount of time to sync application state with an updated node during update.
UpdateDir is the gravity subdirectory where update related data is stored.
UpdateTimeout is the max allowed time for system update.
UsedSecondFactorTokenTTL is the time we keep used second factor token to avoid reusing it on replay attacks.
UserResetTokenTTL is a default password reset token expiry time.
ValidateCommand defines the command executed to verify the connectivity with a remote node.
VendorPattern is the default app vendor pattern that matches all yaml files.
VxlanPort is the port used for overlay network.
WaitForEtcdScript is the path to the planet wait for etcd to be available script.
WaitForEventInterval indicates the delay between above attempts.
WaitForEventMaxAttempts is the maximum number of attempts to query k8s Events API when waiting for a certain event to happen.
WaitStatusInterval specifies the frequency of status checking in wait a operation.
WizardAuthServerPort defines alternative port for auth server.
WizardConnectionGraceTTL is the time interval after which reverse tunnel from cluster to the installer process expires after completing the final installation step.
WizardHealthPort defines alternative port for gravity's health endpoint.
WizardLinkTTL is the interval the remote access link to interactive wizard expires after in case of successful installation.
WizardPackServerPort defines alternative port for package service.
WizardPassword is a default password used for wizard.
WizardProxyServerPort defines alternative port for proxy server.
WizardReverseTunnelPort defines alternative port for reverse tunnel service.
WizardSSHServerPort defines alternative port for SSH server.
WizardUser is a default auto-created user used in wizard mode.
WizardWebProxyPort defines alternative port for web proxy server.
WritableDir is the /writable directory on host (e.g.
WriteFactor is a default amount of acknowledged writes for object storage to be considered successful.
# Variables
AlertmanagerServiceAddr returns the Prometheus Alertmanager HTTP API service address.
AWSPublicIPv4Command is a command to query AWS metadata for an instance's public IP address.
BaseTaintsVersion sets the minimum version with support for node taints and tolerations in system applications.
BaseUpdateVersion sets the minimum version that this binary can update.
ClusterRegistryDir is the location of the cluster's Docker registry backend.
ContainerImage is the image implicitly bundled with any application package.
DockerRegistry is a default name for private docker registry.
FlannelBackend specifies the default flannel backend.
GenerateDebugReportTimeout specifies the maximum amount of time to wait for cluster-wide debug report generation.
GravityAgentBinAlternate defines the gravity binary used during upgrades on Ubuntu Core.
GravityConfigDirs specify default locations for gravity configuration search.
GravityRPCAgentDir specifies the directory used by the RPC agent.
GravityServiceURL defines the address the internal gravity site is located.
GravitySiteSelector is a label for a gravity-site pod.
GravitySystemLogPath defines the default location for the system log.
GravityUserLogPath the default location for user-facing log file.
HelmRegistryVar is the Helm variable that gets passed via --set flag and sets the registry variable to the address of internal cluster registry: image.registry=leader.telekube.local:5000/.
KubeControllerManagerPort specifies the default controller manager healthz port.
KubeletArgs is a list of default command line options for kubelet.
KubernetesAPIAddress is the Kubernetes API address.
KubernetesAPIURL is the Kubernetes API URL.
KubernetesReportResourceTypes lists the kubernetes resource types used in diagnostics report.
LocalCacheDir is the location where gravity stores downloaded packages.
LocalRegistryAddr is the address of the local docker registry.
LocalWizardURL is the local URL of the wizard process API.
LogServiceURL is the URL of logging app API running in the cluster.
MaxExpandConcurrency is the number of servers that can be joining the cluster concurrently.
NetworkInterfacePrefixes is a list of Kubernetes-specific network interface prefixes.
ServiceAddr is the template for a Kubernetes service address.
TeleportCiphers is the whitelist of ciphers to enable in embedded teleport services.
TeleportKEXAlgorithms is the whitelist of key exchange algorithms to enable in embedded teleport services.
TeleportMACAlgorithms is the whitelist of mac algorithms to enable in embedded teleport services.
TeleportVersion specifies the version of the bundled teleport package as a semver.
Will be replaced with actual version at link time.
UsedNamespaces lists the Kubernetes namespaces used by default.
WormholeImg is the docker image reference to use when embedding wormhole Note: This is a build parameter, and the build scripts will replace this with an image reference.
# Type aliases
ReconcileMode is the type for reconcile mode values.