-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into automation/vendor-portal-release-notes-v2024…
….05.03-1
- Loading branch information
Showing
14 changed files
with
199 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Air gap bundles (`.airgap`) contain the images needed to install and run a single release of your application in _air gap_ environments with no outbound internet access. For more information about how to build and download air gap bundles, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
The `builder` key has the following requirements and recommendations: | ||
* Replicated recommends that you include only the minimum Helm values in the `builder` key that are required to template the Helm chart with the correct image tags. | ||
* Use only static, or _hardcoded_, values in the `builder` key. You cannot use template functions in the `builder` key because values in the `builder` key are not rendered in a customer environment. | ||
* Any Helm values entries that are required for rendering Helm chart templates must have a value supplied in the `builder` key. For more information about the Helm `required` function, see [Using the 'required' function](https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-required-function) in the Helm documentation. | ||
* Any Helm values that are required for rendering Helm chart templates must have a value supplied in the `builder` key. For more information about the Helm `required` function, see [Using the 'required' function](https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-required-function) in the Helm documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
To create an `.airgap` bundle for a release that uses Helm charts, the Replicated vendor portal renders the Helm charts' templates with `helm template`. The `builder` key specifies the Helm chart values that the vendor portal uses when running `helm template` to create the `.airgap` bundle. | ||
In the `builder` key, you provide the minimum Helm values required to render the chart templates so that the output includes any images that must be included in the air gap bundle. The vendor portal uses these values to render the Helm chart templates when building the `.airgap` bundle for the release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
import HelmBuilderRequirements from "../partials/helm/_helm-builder-requirements.mdx" | ||
import BuilderAirgapIntro from "../partials/helm/_helm-cr-builder-airgap-intro.mdx" | ||
import BuilderExample from "../partials/helm/_helm-cr-builder-example.mdx" | ||
import AirGapBundle from "../partials/airgap/_airgap-bundle.mdx" | ||
|
||
# Packaging Air Gap Bundles for Helm Charts | ||
|
||
This topic describes how to package and build air gap bundles for releases that contain one or more Helm charts. This topic applies to applications deployed with Replicated KOTS. | ||
|
||
## Overview | ||
|
||
<AirGapBundle/> | ||
|
||
When building the `.airgap` bundle for a release that contains one or more Helm charts, the vendor portal renders the Helm chart templates in the release using values supplied in the KOTS HelmChart custom resource [`builder`](/reference/custom-resource-helmchart-v2#builder) key. This ensures that the `.airgap` bundle includes all images needed to successfully deploy the chart in air gap environments. | ||
|
||
## Configure the `builder` Key | ||
|
||
To build an `.airgap` bundle for a release that contains one or more Helm charts, you must configure the [`builder`](/reference/custom-resource-helmchart-v2#builder) key in the KOTS HelmChart custom resource for each Helm chart in the release. | ||
|
||
<BuilderAirgapIntro/> | ||
|
||
The values in the `builder` key map to values in the given Helm chart's `values.yaml` file. For example, `spec.builder.postres.enabled` in the example HelmChart custom resource below would map to a `postgres.enabled` field in the `values.yaml` file for the `samplechart` chart: | ||
|
||
```yaml | ||
# KOTS HelmChart custom resource | ||
|
||
apiVersion: kots.io/v1beta2 | ||
kind: HelmChart | ||
metadata: | ||
name: samplechart | ||
spec: | ||
chart: | ||
name: samplechart | ||
chartVersion: 3.1.7 | ||
builder: | ||
postgres: | ||
enabled: true | ||
``` | ||
|
||
For requirements, recommendations, and examples of common use cases for the `builder` key, see the sections below. | ||
|
||
### Requirements and Recommendations | ||
|
||
<HelmBuilderRequirements/> | ||
|
||
### Example: Set the Image Registry for Air Gap Installations | ||
|
||
For air gap installations, if the [Replicated proxy service](/vendor/private-images-about) domain `proxy.replicated.com` is used as the default image name for any images, you need to rewrite the image to the upstream image name so that it can be processed and included in the air gap bundle. You can use the `builder` key to do this by hardcoding the upstream location of the image (image registry, repository, and tag), as shown in the example below: | ||
|
||
```yaml | ||
apiVersion: kots.io/v1beta2 | ||
kind: HelmChart | ||
metadata: | ||
name: samplechart | ||
spec: | ||
chart: | ||
name: samplechart | ||
chartVersion: 3.1.7 | ||
builder: | ||
my-service: | ||
image: | ||
registry: 12345.dkr.ecr.us-west-1.amazonaws.com | ||
repository: my-app | ||
tag: "1.0.2" | ||
``` | ||
When building the `.airgap` bundle for the release, the vendor portal uses the registry, repository, and tag values supplied in the `builder` key to template the Helm chart, rather than the default values defined in the Helm `values.yaml` file. This ensures that the image is pulled from the upstream registry using the credentials supplied in the vendor portal, without requiring any changes to the Helm chart directly. | ||
|
||
### Example: Include Conditional Images | ||
|
||
Many applications have images that are included or excluded based on a given condition. For example, enterprise users might have the option to deploy an embedded database with the application or bring their own database. To support this use case for air gap installations, the images for any conditionally-deployed components must always be included in the air gap bundle. | ||
|
||
<BuilderExample/> | ||
|
||
## Related Topics | ||
|
||
* [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles) | ||
* [Build and Download the Application Bundle](/vendor/releases-download-airgap-bundles#air-gap-bundle) | ||
* [builder](/reference/custom-resource-helmchart-v2#builder) | ||
* [Air Gap Installation in Existing Clusters](/enterprise/installing-existing-cluster-airgapped) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
import AirGapBundle from "../partials/airgap/_airgap-bundle.mdx" | ||
|
||
# Defining Additional Images | ||
|
||
This topic describes how to define additional images to be included in the `.airgap` bundle for a release. | ||
|
||
## Overview | ||
|
||
<AirGapBundle/> | ||
|
||
When building the `.airgap` bundle for a release, the Replicated vendor portal finds and includes all images defined in the Pod specs for the release. During installation or upgrade, KOTS retags images from the `.airgap` bundle and pushes them to the registry configured in KOTS. | ||
|
||
Any required images that are _not_ defined in your application manifests must be listed in the `additionalImages` attribute of the KOTS Application custom resource. This ensures that the images are included in the `.airgap` bundle for the release. | ||
|
||
## Define Additional Images for Air Gap Bundles | ||
|
||
KOTS supports including the following types of images in the `additionalImages` field: | ||
|
||
* Public images referenced by the docker pullable image name. | ||
* Images pushed to a private registry that was configured in the vendor portal, referenced by the docker-pullable, upstream image name. For more information about configuring private registries, see [Connecting to an External Registry](/vendor/packaging-private-images). | ||
:::note | ||
If you use the [Replicated proxy service](/vendor/private-images-about) for online (internet-connected) installations, be sure to use the _upstream_ image name in the `additionalImages` field, rather than referencing the location of the image at `proxy.replicated.com`. | ||
::: | ||
* Images pushed to the Replicated registry referenced by the `registry.replicated.com` name. | ||
|
||
The following example demonstrates adding multiple images to `additionalImages`: | ||
|
||
```yaml | ||
apiVersion: kots.io/v1beta1 | ||
kind: Application | ||
metadata: | ||
name: my-app | ||
spec: | ||
additionalImages: | ||
- elasticsearch:7.6.0 | ||
- quay.io/orgname/private-image:v1.2.3 | ||
- registry.replicated.com/my-operator/my-private-image:abd123f | ||
``` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters