Packages configuration

Full EKS Anywhere configuration reference for curated packages

This is a generic template with detailed descriptions below for reference. To generate your own package configuration, follow instructions from Package Management section and modify it using descriptions below.

apiVersion: anywhere.eks.amazonaws.com/v1alpha1
kind: PackageBundleController
metadata:
  name: eksa-packages-bundle-controller
  namespace: eksa-packages
spec:
  activeBundle: v1-21-83
  defaultImageRegistry: 783794618700.dkr.ecr.us-west-2.amazonaws.com
  defaultRegistry: public.ecr.aws/eks-anywhere
  privateRegistry: ""
  upgradeCheckInterval: 24h0m0s

---
apiVersion: packages.eks.amazonaws.com/v1alpha1
kind: PackageBundle
metadata:
  name: package-bundle
  namespace: eksa-packages
spec:
  packages:
    - name: hello-eks-anywhere
      source:
        repository: hello-eks-anywhere
        versions:
          - digest: sha256:c31242a2f94a58017409df163debc01430de65ded6bdfc5496c29d6a6cbc0d94
            images:
              - digest: sha256:26e3f2f9aa546fee833218ece3fe7561971fd905cef40f685fd1b5b09c6fb71d
                repository: hello-eks-anywhere
            name: 0.1.1-083e68edbbc62ca0228a5669e89e4d3da99ff73b
            schema: H4sIAJc5EW...

---
apiVersion: packages.eks.amazonaws.com/v1alpha1
kind: Package
metadata:
  name: my-hello-eks-anywhere
  namespace: eksa-packages
spec:
  config: |
        title: "My Hello"
  packageName: hello-eks-anywhere
  targetNamespace: eksa-packages

API Reference

Packages:

packages.eks.amazonaws.com/v1alpha1

packages.eks.amazonaws.com/v1alpha1

Resource Types:

PackageBundleController
PackageBundle
Package

PackageBundleController

^{^{↩ Parent}}

PackageBundleController is the Schema for the packagebundlecontroller API.

Name	Type	Description	Required
apiVersion	string	packages.eks.amazonaws.com/v1alpha1	true
kind	string	PackageBundleController	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	PackageBundleControllerSpec defines the desired state of PackageBundleController.	false
status	object	PackageBundleControllerStatus defines the observed state of PackageBundleController.	false

PackageBundleController.spec

^{^{↩ Parent}}

PackageBundleControllerSpec defines the desired state of PackageBundleController.

Name	Type	Description	Required
activeBundle	string	ActiveBundle is name of the bundle from which packages should be sourced.	false
bundleRepository	string	Repository portion of an OCI address to the bundle Default: eks-anywhere-packages-bundles	false
createNamespace	boolean	Allow target namespace creation by the controller Default: false	false
defaultImageRegistry	string	DefaultImageRegistry for pulling images Default: 783794618700.dkr.ecr.us-west-2.amazonaws.com	false
defaultRegistry	string	DefaultRegistry for pulling helm charts and the bundle Default: public.ecr.aws/eks-anywhere	false
logLevel	integer	LogLevel controls the verbosity of logging in the controller. Format: int32	false
privateRegistry	string	PrivateRegistry is the registry being used for all images, charts and bundles	false
upgradeCheckInterval	string	UpgradeCheckInterval is the time between upgrade checks. The format is that of time's ParseDuration. Default: 24h	false
upgradeCheckShortInterval	string	UpgradeCheckShortInterval time between upgrade checks if there is a problem. The format is that of time's ParseDuration. Default: 1h	false

PackageBundleController.status

^{^{↩ Parent}}

PackageBundleControllerStatus defines the observed state of PackageBundleController.

Name	Type	Description	Required
detail	string	Detail of the state.	false
spec	object	Spec previous settings	false
state	enum	State of the bundle controller. Enum: ignored, active, disconnected, upgrade available	false

PackageBundleController.status.spec

^{^{↩ Parent}}

Spec previous settings

Name	Type	Description	Required
activeBundle	string	ActiveBundle is name of the bundle from which packages should be sourced.	false
bundleRepository	string	Repository portion of an OCI address to the bundle Default: eks-anywhere-packages-bundles	false
createNamespace	boolean	Allow target namespace creation by the controller Default: false	false
defaultImageRegistry	string	DefaultImageRegistry for pulling images Default: 783794618700.dkr.ecr.us-west-2.amazonaws.com	false
defaultRegistry	string	DefaultRegistry for pulling helm charts and the bundle Default: public.ecr.aws/eks-anywhere	false
logLevel	integer	LogLevel controls the verbosity of logging in the controller. Format: int32	false
privateRegistry	string	PrivateRegistry is the registry being used for all images, charts and bundles	false
upgradeCheckInterval	string	UpgradeCheckInterval is the time between upgrade checks. The format is that of time's ParseDuration. Default: 24h	false
upgradeCheckShortInterval	string	UpgradeCheckShortInterval time between upgrade checks if there is a problem. The format is that of time's ParseDuration. Default: 1h	false

PackageBundle

^{^{↩ Parent}}

PackageBundle is the Schema for the packagebundle API.

Name	Type	Description	Required
apiVersion	string	packages.eks.amazonaws.com/v1alpha1	true
kind	string	PackageBundle	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	PackageBundleSpec defines the desired state of PackageBundle.	false
status	object	PackageBundleStatus defines the observed state of PackageBundle.	false

PackageBundle.spec

^{^{↩ Parent}}

PackageBundleSpec defines the desired state of PackageBundle.

Name	Type	Description	Required
packages	[]object	Packages supported by this bundle.	true
minControllerVersion	string	Minimum required packages controller version	false

PackageBundle.spec.packages[index]

^{^{↩ Parent}}

BundlePackage specifies a package within a bundle.

Name	Type	Description	Required
source	object	Source location for the package (probably a helm chart).	true
name	string	Name of the package.	false
workloadonly	boolean	WorkloadOnly specifies if the package should be installed only on the workload cluster	false

PackageBundle.spec.packages[index].source

^{^{↩ Parent}}

Source location for the package (probably a helm chart).

Name	Type	Description	Required
repository	string	Repository within the Registry where the package is found.	true
versions	[]object	Versions of the package supported by this bundle.	true
registry	string	Registry in which the package is found.	false

PackageBundle.spec.packages[index].source.versions[index]

^{^{↩ Parent}}

SourceVersion describes a version of a package within a repository.

Name	Type	Description	Required
digest	string	Digest is a checksum value identifying the version of the package and its contents.	true
name	string	Name is a human-friendly description of the version, e.g. "v1.0".	true
dependencies	[]string	Dependencies to be installed before the package	false
images	[]object	Images is a list of images used by this version of the package.	false
schema	string	Schema is a base64 encoded, gzipped json schema used to validate package configurations.	false

PackageBundle.spec.packages[index].source.versions[index].images[index]

^{^{↩ Parent}}

VersionImages is an image used by a version of a package.

Name	Type	Description	Required
digest	string	Digest is a checksum value identifying the version of the package and its contents.	true
repository	string	Repository within the Registry where the package is found.	true

PackageBundle.status

^{^{↩ Parent}}

PackageBundleStatus defines the observed state of PackageBundle.

Name	Type	Description	Required
state	enum	PackageBundleStateEnum defines the observed state of PackageBundle. Enum: available, ignored, invalid, controller upgrade required	true
spec	object	PackageBundleSpec defines the desired state of PackageBundle.	false

PackageBundle.status.spec

^{^{↩ Parent}}

PackageBundleSpec defines the desired state of PackageBundle.

Name	Type	Description	Required
packages	[]object	Packages supported by this bundle.	true
minControllerVersion	string	Minimum required packages controller version	false

PackageBundle.status.spec.packages[index]

^{^{↩ Parent}}

BundlePackage specifies a package within a bundle.

Name	Type	Description	Required
source	object	Source location for the package (probably a helm chart).	true
name	string	Name of the package.	false
workloadonly	boolean	WorkloadOnly specifies if the package should be installed only on the workload cluster	false

PackageBundle.status.spec.packages[index].source

^{^{↩ Parent}}

Source location for the package (probably a helm chart).

Name	Type	Description	Required
repository	string	Repository within the Registry where the package is found.	true
versions	[]object	Versions of the package supported by this bundle.	true
registry	string	Registry in which the package is found.	false

PackageBundle.status.spec.packages[index].source.versions[index]

^{^{↩ Parent}}

SourceVersion describes a version of a package within a repository.

Name	Type	Description	Required
digest	string	Digest is a checksum value identifying the version of the package and its contents.	true
name	string	Name is a human-friendly description of the version, e.g. "v1.0".	true
dependencies	[]string	Dependencies to be installed before the package	false
images	[]object	Images is a list of images used by this version of the package.	false
schema	string	Schema is a base64 encoded, gzipped json schema used to validate package configurations.	false

PackageBundle.status.spec.packages[index].source.versions[index].images[index]

^{^{↩ Parent}}

VersionImages is an image used by a version of a package.

Name	Type	Description	Required
digest	string	Digest is a checksum value identifying the version of the package and its contents.	true
repository	string	Repository within the Registry where the package is found.	true

Package

^{^{↩ Parent}}

Package is the Schema for the package API.

Name	Type	Description	Required
apiVersion	string	packages.eks.amazonaws.com/v1alpha1	true
kind	string	Package	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	PackageSpec defines the desired state of an package.	false
status	object	PackageStatus defines the observed state of Package.	false

Package.spec

^{^{↩ Parent}}

PackageSpec defines the desired state of an package.

Name	Type	Description	Required
packageName	string	PackageName is the name of the package as specified in the bundle.	true
config	string	Config for the package.	false
packageVersion	string	PackageVersion is a human-friendly version name or sha256 checksum for the package, as specified in the bundle.	false
targetNamespace	string	TargetNamespace defines where package resources will be deployed.	false

Package.status

^{^{↩ Parent}}

PackageStatus defines the observed state of Package.

Name	Type	Description	Required
currentVersion	string	Version currently installed.	true
source	object	Source associated with the installation.	true
detail	string	Detail of the state.	false
spec	object	Spec previous settings	false
state	enum	State of the installation. Enum: initializing, installing, installing dependencies, installed, updating, uninstalling, unknown	false
targetVersion	string	Version to be installed.	false
upgradesAvailable	[]object	UpgradesAvailable indicates upgraded versions in the bundle.	false

Package.status.source

^{^{↩ Parent}}

Source associated with the installation.

Name	Type	Description	Required
digest	string	Digest is a checksum value identifying the version of the package and its contents.	true
registry	string	Registry in which the package is found.	true
repository	string	Repository within the Registry where the package is found.	true
version	string	Versions of the package supported.	true

Package.status.spec

^{^{↩ Parent}}

Spec previous settings

Name	Type	Description	Required
packageName	string	PackageName is the name of the package as specified in the bundle.	true
config	string	Config for the package.	false
packageVersion	string	PackageVersion is a human-friendly version name or sha256 checksum for the package, as specified in the bundle.	false
targetNamespace	string	TargetNamespace defines where package resources will be deployed.	false

Package.status.upgradesAvailable[index]

^{^{↩ Parent}}

PackageAvailableUpgrade details the package’s available upgrade versions.

Name	Type	Description	Required
tag	string	Tag is a specific version number or sha256 checksum for the package upgrade.	true
version	string	Version is a human-friendly version name for the package upgrade.	true