(Optional) Store Helm charts and Docker container images in a private artifact registry¶
Helm charts, Docker container images, and the artifact registry¶
Helm charts¶
The Helm charts for F5 BIG-IP Cloud-Native Edition are stored in an artifact registry and referenced when necessary.
When Helm charts are referenced¶
You reference a Helm chart when you perform a clean installation or an upgrade of F5 BIG-IP Cloud-Native Edition using Helm.
Docker container images¶
The F5 BIG-IP Cloud-Native Edition components run as a set of Docker containers whose images are stored in an artifact registry and pulled (downloaded) by Kubernetes when necessary.
When Docker container images are pulled¶
Kubernetes pulls the Docker container images for F5 BIG-IP Cloud-Native Edition during a clean installation or an upgrade and—when necessary—while F5 BIG-IP Cloud-Native Edition is running on your cluster.
Default artifact registry versus private artifact registry¶
By default, you reference Helm charts in—and Kubernetes pulls Docker container images from—F5 Artifact Registry, which is available over the public internet.
However, you can instead reference Helm charts in—and have Kubernetes pull Docker container images from—a private artifact registry.
Note
The private artifact registry must be an OCI registry.
The private artifact registry must be accessible by your cluster.
The private artifact registry must be accessible by your computer.
You must be authorized to push artifacts to the private artifact registry.
When to use a private artifact registry¶
Use a private artifact registry instead of the default artifact registry if any of the following are true:
Your cluster is not connected to the public internet (this is sometimes referred to as an air-gapped cluster).
You want to use your own infrastructure to store Helm charts and Docker container images for improved security and reliability.
Create a pull-secret manifest for authenticating to the private artifact registry¶
Introduction¶
If the private artifact registry requires authentication (that is, you must provide credentials to access the registry), you must create a pull-secret manifest for authenticating to the registry. Typically, a private artifact registry in an air-gapped cluster doesn’t require authentication.
How the pull-secret manifest is used¶
When you later perform a clean installation of the CNE core and CNE instances (each in its own namespace), you’ll use the pull-secret manifest to create a pull secret for the private artifact registry in each namespace. Kubernetes uses the private artifact registry’s pull secret to authenticate to the private artifact registry when pulling Docker container images from it.
Create a pull-secret manifest for authenticating to the private artifact registry¶
In a terminal window on your computer, make sure you’re in the release-manifest directory, which contains the release manifest (
bigip-k8s-manifest-<version>.yaml).Create the private artifact registry’s pull-secret manifest.
Note
You can use any name you like for the pull secret except
far-pull-secret, which is reserved as the name of the F5 Artifact Registry pull secret.Most artifact registries can provide you with a pull-secret manifest, which looks like this for a pull secret named
private-registry-pull-secret:apiVersion: v1 kind: Secret metadata: name: private-registry-pull-secret data: .dockerconfigjson: eyJodHRwczovL2luZGV4L...J0QUl6RTIifX0= type: kubernetes.io/dockerconfigjson
If your registry can’t provide you with a pull-secret manifest, see Pull an Image from a Private Registry.
Store Helm charts and Docker container images in a private artifact registry¶
Introduction¶
The following instructions describe how to store Helm charts and Docker container images in a private artifact registry.
Note
Follow these guidelines:
Follow the instructions below only if you’re using a private artifact registry.
Perform the tasks in order.
Log in to F5 Artifact Registry with Helm¶
Note
Unless you log out (or get logged out), you need to log in to F5 Artifact Registry only once with Helm.
Make sure your computer is connected to the public internet.
In a terminal window on your computer, make sure you’re in the F5 BIG-IP Cloud-Native Edition directory (for example,
f5-big-ip-cne), which contains your F5 Artifact Registry service-account key (cne_pull_64.json).Log in to F5 Artifact Registry with Helm:
$ cat cne_pull_64.json | helm registry login \ --username _json_key_base64 \ --password-stdin repo.f5.com
You can now use Helm commands on your computer to reference Helm charts in F5 Artifact Registry.
Log in to F5 Artifact Registry with Docker¶
Note
Unless you log out (or get logged out), you need to log in to F5 Artifact Registry only once with Docker.
Make sure your computer is connected to the public internet.
In a terminal window on your computer, make sure you’re in the F5 BIG-IP Cloud-Native Edition directory (for example,
f5-big-ip-cne), which contains your F5 Artifact Registry service-account key (cne_pull_64.json).Log in to F5 Artifact Registry with Docker:
$ cat cne_pull_64.json | docker login \ --username _json_key_base64 \ --password-stdin repo.f5.com
You can now use Docker commands on your computer to reference Docker container images in F5 Artifact Registry.
Pull Helm charts and Docker container images from F5 Artifact Registry¶
In a terminal window on your computer, make sure you’re in the release-manifest directory.
Open the release manifest in a text editor.
Using the versions shown in the release manifest, pull all the Helm charts and Docker container images for F5 BIG-IP Cloud-Native Edition to your computer.
Store Helm charts and Docker container images in the private artifact repository¶
In a terminal window on your computer, make sure you’re in the release-manifest directory.
If the private artifact registry requires authentication, log in to it with Helm and Docker.
Make sure you’re authorized to push artifacts to the private artifact registry.
Store all the Helm charts and Docker container images for F5 BIG-IP Cloud-Native Edition in the private artifact repository.
Close the release manifest.