package
0.0.0-20230628214157-3bfe64699e82
Repository: https://github.com/gravitational/gravity.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
Package v1 is the v1 version of the API.

# Functions

AllHooks obtains the list of all hook types.
CheckAndSetDefaults verifies that the specified manifest does not have conflicting or errorneous attributes set.
DiffPorts returns a difference of port requirements between old and new for the specified profile.
DiffVolumes returns a difference between old and new volume requirements.
ExpandEnvVars does environment variables interpolation on manifest body.
GetProviderFromProvisioner derives a provider name from the specified provisioner.
GetProvisionerFromProvider derives a provisioner name from the specified provider.
HookFromString returns an application hook specified with hookType.
IsAWSProvider determines if specified provider string refers to AWS provider.
MustParseManifestYAML parser the provided manifest data and panics in case of parsing error.
ParseManifest parses manifest file at the specified path.
ParseManifestYAML parses the provided data as an application manifest and validates it.
ParseManifestYAMLNoValidate parses the provided data as an application manifest and does not run any validation checks on it.
ProcessMultiSourceValues replaces manifest fields that refer to files (via file:// schema) or internet resources (via http:// scheme) with their literal values (i.e.
SetDefaults enforces defaults on fields that require a value but have not been specified on the given manifest.
ShouldSkipApp returns true if the specified application should not be installed in the cluster described by the provided manifest.
ValidateDocker validates Docker requirements.
ValidateKubelet will check kubelet configuration.
ValidateRequirements will assess local node to match requirements.

# Constants

AdvertiseAddr is advertise IP address used in agents.
APIVersionLegacyV2 specifies legacy v2 version.
APIVersionV1 specifies the previous API version.
AppGroupName is the API group for app image manifest.
ApplicationDefaultNamespace defines the default application manifest.
ClusterGroupName is the API group for cluster image manifest.
DisplayRole defines a role used to identify a server instance in the inventory management console.
ExpandPolicyFixed is a node membership policy that prevents adding more nodes of the same role.
ExpandPolicyFixedInstance is a node membership policy that allows adding nodes of the same role with the same instance type only (for cloud providers).
GCENodeTags defines the name of the agent download URI query parameter to override instance node tags on GCE.
GroupName specifies the name of the group for application manifest package.
HookBackup defines a hook to trigger backup of application data.
HookBeforeUpdate defines the application hook that runs before the update.
HookClusterDeprovision used to deprovision existing cluster.
HookClusterProvision used to provision new cluster.
HookDump defines the application dump hook.
HookInfo defines the application service info hook.
HookInstall defines the installation hook.
HookInstalled defines the post install hook.
HookLicenseUpdated defines the license update hook.
HookNetworkInstall defines a hook used to install a custom overlay network.
HookNetworkRollback defines a hook to rollback the overlay network.
HookNetworkUpdate defines a hook to update the overlay network.
HookNodeAdded defines the post expand hook.
HookNodeAdding defines the before expand hook.
HookNodeRemoved defines the post shrink hook.
HookNodeRemoving defines the before shrink hook.
HookNodesDeprovision used to deprovision existing nodes.
HookNodesProvision used to provision new nodes in the cluster.
HookRestore defines a hook to restore application state from a previously created backup.
HookRollback defines the application rollback hook.
HookRolledBack defines the application post rollback hook.
HookStart defines the application start hook.
HookStatus defines the application status hook.
HookStop defines the application stop hook.
HookUninstall defines the installation hook.
HookUninstalling defines the before uninstall hook.
HookUpdate defines the application update hook.
HookUpdated defines the post application update hook.
KindApplication defines a user application type.
KindBundle defines an application bundle type (obsoleted by "Cluster").
KindCluster defines a cluster type (former "Bundle").
KindRuntime defines a runtime application type.
KindSystemApplication defines a system application type.
LabelRole names a label that defines a node role.
MountSpec defines the name of the agent download URI query parameter for a mount specification.
NetworkingAWSVPC defines a type of networking for AWS based on AWS-VPC.
NetworkingCalico defines a type of networking using Calico.
NetworkingFlannel defines a type of networking using Flannel VXLAN.
OpsCenterAppName is the name of the Ops Center application.
OpsCenterFlavor is the Ops Center app flavor.
OpsCenterNode is the Ops Center app node profile name.
ProviderAWS defines AWS as infrastructure provider.
ProviderGCE defines Google Compute Engine provider.
ProviderGeneric defines a generic provider.
ProviderOnPrem defines an On-Premises infrastructure provider.
ProvisionerAWSTerraform defines an operation provisioner based on terraform.
ProvisionerOnPrem defines a provisioner for an On-Premises operation.
SELinuxLabelNone is a special placeholder for a SELinux label indicating that no labeling should be performed for the directory.
ServiceLabelRole names a label that defines a kubernetes node role.
ServiceRoleMaster names a label that defines a master node role.
ServiceRoleNode names a label that defines a regular node role.
SystemDevice defines the name of the agent download URI query parameter for system (state) device.
Version specifies the current package version.

# Variables

APIVersionV2 specifies the current API version.
APIVersionV2App is the API version for app images.
APIVersionV2Cluster is the API version for cluster images.
AppGroupVersion defines group/version for the app image manifest.
ClusterGroupVersion defines group/version for the cluster image manifest.
DefaultKernelModuleChecker is a satellite kernel module checker with required modules to run kubernetes.
DefaultKernelModules is the list of kernel modules needed for gravity to function properly.
DefaultPortRanges defines the list of default ports for the cluster.
SchemeGroupVersion defines group and version for the application manifest type in the kubernetes resource scheme.
SupportedProviders is a list of currently supported providers.

# Structs

AWS defines AWS-specific settings.
Azure defines Azure-specific settings.
BaseImage defines a base image type which is basically a locator with custom marshal/unmarshal.
CatalogExtension allows to customize application catalog feature.
ConfigurationExtension allows to customize configuration feature.
CPU describes CPU requirements.
CustomCheck defines a script that runs a custom preflight check.
Dependencies describes application dependencies.
Dependency represents a package or app dependency.
Device describes a device that should be created inside container.
Docker describes docker options.
EncryptionExtension describes installer encryption extension.
Endpoint describes an application endpoint.
Etcd describes etcd options.
EULA describes the application end user license agreement.
Extensions defines various custom application features.
ExternalService defines configuration for an external service.
Flavor describes a single application flavor.
FlavorNode describes a single node profile for a flavor.
Flavors describes the application flavors.
Generic defines generic provider settings.
Header is manifest header.
Hook defines a hook as either a shell script run in the context of the automatically created job or the raw job spec.
Hooks defines all supported application lifecycle hooks.
IAMPolicy defines a list of AWS permissions.
Ingress represents Ingress configuration.
Installer contains installer customizations.
Kubelet describes kubelet options.
KubernetesExtension allows to customize kubernetes feature.
License describes an application license.
LogsExtension allows to customize logs feature.
Manifest represents an application manifest that describes a Gravity application or cluster image +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object.
Metadata is the application metadata.
MonitoringExtension allows to customize monitoring feature.
Network describes network requirements.
Networking describes networking configuration.
Nginx represents a specific Ingress controller based on nginx.
NodeProfile describes a single node.
NodeProviderAWS describes AWS-specific node settings.
NodeProviders contains provider-specific node settings.
OpenEBS represents OpenEBS configuration.
OpsCenterExtension allows to disable/enable the Ops Center UI.
OS describes OS requirements.
Port describes port ranges.
PortRange describes a range of cluster ports.
PortRanges arranges ports into groups.
Providers defines global provider-specific settings.
RAM describes RAM requirements.
Requirements defines a set of requirements for a node profile.
Runtime describes the application runtime.
Storage represents persistent storage configuration.
SystemDependencies defines additional system-level package dependencies.
SystemOptions defines various global settings.
Volume describes a volume requirement.

# Type aliases

HookType defines the application hook type.
NodeProfiles is a list of node profiles.
ServiceRole defines the type for the node service role.