ExternalDNS formats the provided hostname as a wildcard A record for use with external DNS provisioners.

InstallerClusterName returns the name for the installer trusted cluster for the specified cluster.

AgentStatusTimeoutEnvVar is the name of the environment variable that specifies the agent status timeout value.

AlertTargetConfigMap specifies the name of the ConfigMap with alert target configuration.

AllNamespaces is the filter to search across all namespaces.

AlternativeLoopbackIP is a loopback IP that is used for temporary services that need to be separated from the standard loopback address.

AnnotationKind contains image type, cluster or application.

AnnotationLogo contains base64-encoded image logo.

AnnotationSize contains image size in bytes.

APIServerDomainName is a domain name set by planet active master.

APIServerDomainNameGravity is the leader node FQDN.

APIServerKeyPair is a name of the K8s apiserver key pair.

APIServerKubeletClientKeyPair is the name of the cert for the API server to connect to kubelet.

AppVersionLabel specifies version of an application in a Helm chart.

AssignKubernetesGroupsFnName is a function name that assigns kubernetes groups used in rules definition.

AttachDetachAnnotation is the Kubernetes node annotation that indicates that the node is managed by attach-detach controller running as a part of the controller manager.

AuthGatewayConfigMap is the name of config map with auth gateway configuration.

AWSClusterNameTag is a name of AWS tag which assigns resource to Kubernetes cluster.

AWSLBIdleTimeoutAnnotation is the kubernetes annotation that specifies idle timeout for an AWS load balancer.

BlobUserSuffix is the suffix of a blob service user.

BoltBackend defines storage backend as BoltDB.

BootstrapConfigPackage specifies the name of the package with default roles/security policies.

CertAuthorityPackage is a package with certificate authority.

CloudProviderAWS identifies AWS cloud provider.

ClusterAdminGroup is a group name for Kubernetes cluster amdin.

ClusterCertificateMap is the name of the ConfigMap that contains cluster cert and key.

ClusterCertificateMapKey is the cert field name in the above ConfigMap.

ClusterCertificateUpdatedEvent is an event broadcast when cluster certificate is updated.

ClusterConfigurationMap is the name of the ConfigMap that hosts cluster configuration resource.

ClusterControllerChangeset names the changeset with cluster controller resources of the currently installed version.

ClusterEnvironmentMap is the name of the ConfigMap that contains cluster environment.

ClusterFlavorEnv is the environment variable that contains initial cluster flavor.

ClusterInfoMap is the name of the ConfigMap that contains cluster information.

ClusterKubeProxyUser specifies the name of the user used by kube-proxy.

ClusterNameEnv is the environment variable that contains cluster domain name.

ClusterNodeGroup is a group for Kubernetes nodes (kubelet).

ClusterNodeNamePrefix is the prefix to assign to each cluster node hostname.

ClusterPrivateKeyMapKey is the key field name in the above ConfigMap Note: ConfigMap key names are subject to certain restrictions in earlier versions of kubernetes, use a lowercase notation instead to make it backwards-compatible.

ClusterProviderEnv is the environment variable that contains cluster cloud provider.

Completed defines the value of the progress when the operation is considered done (successful or failed).

ComponentApp is for app service.

ComponentBLOB is for BLOB storage.

ComponentInstaller represents the name of the mode gravity process is running in when started as a standalone installer.

ComponentOps is for operations service.

ComponentSite represents the name of the mode gravity process is running in in a Gravity cluster.

ComponentSystem is for system integration.

ComponentWeb is web frontend.

ConfigMapAPIVersion is a K8s version of this resource.

CoreDNSKeyPair is a cert/key used for accessing coredns related configmap from the kubernetes api.

DevmodeEnvVar is the name of environment variable that is passed inside hook container indicating whether the OpsCenter/Site is started in dev mode.

DNSAppPackage is the name of the dns-app package.

DockerEngineURL is the address of the local docker engine API.

DockerStorageDriverDevicemapper identifes the devicemapper docker storage driver.

DockerStorageDriverOverlay identifes the overlay docker storage driver.

DockerStorageDriverOverlay2 identifes the overlay2 docker storage driver.

EnvAWSAMI sets cloud image name.

EnvAWSInstancePrivateDNS is a private DNS name of the instance.

EnvAWSInstancePrivateIP is a private IP of the instance to delete.

EnvAWSKeyName sets AWS Key Name.

EnvAWSProfile specifies AWS profile to load.

EnvAWSRegion sets AWS region anme.

EnvAWSVPCID sets AWS VPC ID.

EnvCloudProvider sets cloud provider name.

EnvGravityConfig is environment variable setting debugging mode.

EnvGravityTeleportConfig is environment variable setting debugging mode.

EnvHome is home environment variable.

EnvKubeConfig is environment variable for kubeconfig.

EnvNetworkingType specifies the name of environment variable for defining networking type for kubernetes.

EnvPodIP is environment variable that contains pod IP address.

EnvPodName is environment variable with the pod name.

EnvPodNamespace is environment variable with the pod namespace.

EnvSudoGID is environment variable containing id of the group of the user who invoked "sudo".

EnvSudoUID is environment variable containing id of the user who invoked "sudo".

EnvSudoUser is environment variable containing name of the user who invoked "sudo".

EnvTelekubeClusterName is environment variable name for telekube cluster.

EnvTelekubeDevMode specifies whether ops center and clsuter are installed in development mode with some security turned off.

EnvTelekubeFlavor is a flavor set by user in the installation.

EnvTelekubeNodeProfileAddCountTemplate is a template with count of instances to be added by particular manifest profile set by user.

EnvTelekubeNodeProfileCountTemplate is a template with count of instances with a particular manifest profile set by user.

EnvTelekubeNodeProfileInstanceTypeTemplate is a template with instance type per node profile that was picked by user.

EnvTelekubeNodeProfiles enumerates all node profiles.

EnvTelekubeOpsURL is environment variable name with Ops Center URL.

EnvTelekubeOpsVersion is the version of this ops center.

ETCDBackend defines storage backend as Etcd.

ETCDKeyPair is a name of the etcd key pair.

ExternalDNSHostnameAnnotation is the service annotation that is understood by external DNS controllers.

FailureMark is used in CLI to visually indicate failure.

FakeSSHLogin is used as a placeholder for roles that can't use logins.

FieldAdvertiseIP is the log field with node IP.

FieldCommand is a command executed on server.

FieldCommandError is boolean indicator of whether command resulted in error.

FieldCommandErrorReport is error message if command resulted in error.

FieldCommandStderr records executed command's stderr in log.

FieldCommandStdout records executed command's stdout in log.

FieldDir is the log field that contains a directory path which meaning is specific to the component doing the logging.

FieldError contains error message.

FieldHostname is the log field with node hostname.

FieldMode is the log field with the process mode (cluster/opscenter).

FieldOperationID is a logging field for operation id.

FieldOperationProgress defines the attribute that holds the value of the current operation's progres, in percent.

FieldOperationState is a logging field for operation state.

FieldOperationType defines the type of the active operation.

FieldPhase is the log field with phase name.

FieldServer specifies server in case if command runs on the server.

FieldServerIP specifies server in case if command runs on the server with private ip.

FieldSiteDomain is a domain field used in logs.

FieldSuccess contains boolean value whether something succeeded or not.

FinalStep is the number of the final install operation step in UI.

FioBin is the name of the fio binary.

FioPackage is the name of the package with fio binary.

FrontProxyClientKeyPair is a cert/key used for accessing external APIs through aggregation layer.

GatekeeperUser defines a user that remote sites use to connect back to the original OpsCenter.

GrafanaContextCookie hold the name of the cluster used in certain web handlers to determine the currently selected domain without including it in the URL.

GravityAgentDeployed indicates the gravity-agent service has been deployed.

GravityAgentOffline indicates the gravity-agent service is offline.

GravityAgentsService is the name of the Kubernetes service for cluster traffic.

GravityBin is the name of the gravity binary.

GravityCLITag is used to tag gravity cli command log entries in the system journal.

GravityEnvVarPrefix is the prefix for gravity-specific environment variables.

GravityPackage defines a role for the gravity binary package.

GravityPublicService is the name of the Kubernetes service for user traffic.

GravityServiceName is a name of the gravity service.

GravityServicePortName is the port name of the service.

GravitySitePackage specifies the name of the garvity site application package.

GravitySystemContainerType specifies the SELinux domain for the system containers.

HelmChartFile is a helm chart name.

HelmLabel denotes application generated from Helm chart.

HTTPProxyEnvVar is the HTTP_PROXY environment variable.

HTTPSProxyEnvVar is the HTTPS_PROXY environment variable.

HumanDateFormat is a human readable date formatting.

HumanDateFormatMilli is a human readable date formatting with milliseconds.

HumanDateFormatSeconds is a human readable date formatting with seconds.

InProgressMark is used in CLI to visually indicate progress.

InstallerTunnelPrefix is used for a name of a trusted cluster that installer process creates during Ops Center initiated installation.

InstallModeCLI means installation is running in unattended CLI mode.

InstallModeInteractive means installation is running in UI wizard mode.

KeyPair is the TLS key pair name.

KindConfigMap is the Kubernetes ConfigMap resource kind.

KindJob is the Kubernetes Job resource kind.

KindService is the Kubernetes Service resource kind.

Kubeconfig is the path the regular kubeconfig file.

KubectlBin is the name of the kubectl binary.

KubectlConfig is a name of kube config used for kubectl.

KubectlKeyPair is a name of the kubectl client key pair.

KubeLabelSelector is the name of the query string parameter with label selector.

KubeletKeyPair is a name of the Kubelet client Key pair.

KubeletUser specifies the kubelet username.

KubeNodeExternalIP is the name of the k8s node property containing its external IP.

KubeNodeInternalIP is the name of the k8s node property containing its internal IP.

KubernetesKindUser defines the kubernetes user resource type.

KubeSystemNamespace is a k8s namespace.

LatestVersion is the shortcut for the latest Telekube version.

LegacyAPIServerDomainName is legacy domain name used by the leader master node.

LicenseConfigMapName is the name of the k8s config map where license used to be stored, it's still needed for migration purposes.

LicensePackage is the package with license used during initial site installation.

LicenseSecretName is the name of the k8s secret with cluster license.

LocalClusterCommonName is a default Common Name of the local K8s cluster.

Localhost is local host.

LogFnName is a name for log function available in rules definitions.

LograngeAdaptorKeyPair is a cert/key used by logrange adaptor component.

LograngeAggregatorKeyPair is a cert/key used by logrange aggregator component.

LograngeCollectorKeyPair is a cert/key used by logrange collector component.

LograngeForwarderKeyPair is a cert/key used by logrange forwarder component.

LoopbackIP is IP of the loopback interface.

ManualUpdateEnvVar names the environment variable that specifies if the update is in manual mode.

MasterLabel is a standard kubernetes label to designate or mark as a master node (node running kubernetes masters).

MaxInteractiveSessionTTL is a max time for an interactive session.

MonitoringType specifies the name of the type label for monitoring.

MonitoringTypeAlert specifies the value of the component label for monitoring alerts.

MonitoringTypeAlertTarget specifies the value of the component label for monitoring alert targets.

MonitoringTypeSMTP specifies the value of the component label for monitoring SMTP updates.

NodeLabel is a standard kubernetes label to designate or mark as a regular node.

OpenEBSNDMConfigMap is the name of the ConfigMap with OpenEBS node device manager configuration.

OpenEBSNDMDaemonSet is the name of the OpenEBS node device manager DaemonSet.

OperatorContext is for operator associated with User ACL context.

OpsCenterCAPackage is the package containing certificate authority for OpsCenter.

OpsCenterKeyPair is a name of key pair for OpsCenter.

OpsCenterUser is the name of the user that is used to execute teleport commands.

PeriodicUpdatesOff is an argument that disables periodic updates.

PlanetConfigPackage is the package with planet configuration.

PlanetPackage is the package with planet.

PlanetRootfs is the planet's rootfs.

PlanetRPCKeyPair is a keypair for planet's RPC client for satellite monitoring and exchange.

PlanetSecretsPackage is the package with planet secrets - keys, CA and other stuff.

PreflightChecksOffEnvVar is the name of environment variable that can be used to turn off preflight checks during install or update.

PreviousKeyValuesAnnotationKey defines the annotation field that keeps the old environment variables after the update.

PrivilegedKubeconfig is a path to privileged kube config that is stored on K8s master node.

PrometheusKeyPair is a cert/key used by prometheus-operator.

ProxyKeyPair is a name of the K8s Proxy client Key Pair.

RbacAPIGroup specifies the API group for RBAC.

Redacted is used as a replacement string for sensitive data.

RegistryDomainName is another alias for the leader node FQDN.

Required means that this value is required.

ResourceSpecKey specifies the name of the key with raw resource specification.

RoleAdmin is admin role.

RoleAgent is cluster agent role.

RoleGatekeeper is gatekeeper role.

RoleOneTimeLink is a role for one-time link installation.

RoleReader gives access to some system packages and roles used in tele build to download artifacts from ops centers.

RollbackMark is used in CLI to visually indicate rollback.

RootGID is the root group ID.

RootKeyPair is a name of the K8s root certificate authority keypair.

RootUID is the root user ID.

RootUIDString is the root user ID.

RPCAgentSyncPlanFunction requests deployed agents to synchronize local backend with cluster.

RPCAgentUpgradeFunction requests deployed agents to run automatic upgrade operation on leader node.

SchedulerKeyPair is a name of the K8s scheduler client key pair.

ServiceAPIVersion is a K8s version of this resource.

ServiceAutoscaler is the name of the service that monitors autoscaling events and launches appropriate operations.

ServiceGroupEnvVar names the environment variable that specifies the service group ID.

ServiceSelfLeaderEvent defines an event sent when the gravity service becomes the leader.

ServiceStartedEvent defines an event to identify when the main gravity service has completed initialization.

ServiceStatusChecker is the name of the service that periodically checks cluster health status and activates/deactivates it.

ServiceSystem is the identifier used as a "user" field for events that are triggered not by a human user but by a system process.

ServiceUserEnvVar names the environment variable that specifies the service user ID.

SessionCookie is the name of the cookie that contains web session.

ShortDateFormat is the short version of human readable timestamp format.

SiteExportPackage is the package with site export data.

SiteInitLock is a name of a distributed site lock that is used for one time import procedure.

SiteInstallLogsPackage defines a package with site installation logs.

SiteShrinkAgentPackage defines a package with shrink agent start commands.

SMTPSecret specifies the name of the Secret with cluster SMTP configurationnolint:gosec // not a real secret.

StableVersion is the shortcut for the latest stable Telekube version.

SuccessMark is used in CLI to visually indicate success.

SystemLabel is used to identify object as a system.

TarExtension is the tar file extension.

TelekubeMountDir is a directory where telekube mounts specific secrets and other configuration parameters.

TelePackage is the name of the package with 'tele' binary.

TeleportMasterConfigPackage is the name of the config package of teleport.

TeleportNodeConfigPackage is the name of the config package of teleport.

TeleportPackage is the package name for teleport - SSH access tool.

TimeFormat is the time format that only displays time.

True is a boolean 'true' value.

TrustedClusterPackage is the name of the package that contains trusted cluster spec for external Ops Center when installing in wizard mode.

TshPackage is the name of the package with 'tsh' binary.

UpdateAgentChangeset names the changeset with update agent resources.

UpdateClusterControllerChangeset names the changeset with cluster controller resources of the update version.

UserContext is a context field that contains authenticated user name.

WarnMark is used in CLI to visually indicate a warning.

WebAssetsPackage names the web assets package.

WebSessionContext is for web sessions stored in the current context.

WireguardNetworkType is a network type that is used for wireguard/wormhole support.

WithSecretsParam is a URL parameter name used in API to identify that resource has to be pulled with secrets.

BaseImageName is the current base cluster image name.

DockerSupportedDrivers is a list of recognized docker storage drivers.

DockerSupportedTargetDrivers is a list of docker storage drivers that the existing storage driver can be switched to.

EncodingJSON is for the JSON encoding format.

EncodingPEM is for the PEM encoding format.

EncodingShort is for short output format.

EncodingText is for the plaint-text encoding format.

EncodingYAML is for the YAML encoding format.

HubImageName is the name of the Hub cluster image.

KubeLegacyVersion defines the version of kubernetes used for compatibility.

KubernetesServiceDomainNames specifies the domain names of the kubernetes API service.

LegacyBaseImageName is the name of the base cluster image used in earlier versions.

LegacyHubImageName is the legacy name of the Hub cluster image.

OutputFormats is a list of recognized output formats for gravity CLI commands.

Format is the type for supported output formats.