Offline Installation - Private registry
Before starting the installation, make sure the requirements are met.
Configure the registry
If your cluster is in an air-gapped network or is unable to reach the Akamas image repository, you need to copy the required images to your private registry.
The procedure described here leverages your local environment to upload the images. Thus, to interact between the Akamas and private registry, it requires Docker to be installed and configured.
Transfer the Docker images
The offline installation requires you to pull the images and migrate them to your private registry. In the following command replace the chart version to download the related list of images:
Once the import is complete, you must re-tag and upload the images. Run the following snippet, replacing <REGISTRY_URL>
with the actual URL of the private registry:
This process could last several minutes, once the upload is complete, you can proceed with the next steps.
Create the configuration file
Akamas on Kubernetes is provided as a set of templates packaged in a chart archive managed by Helm.
To proceed with the installation, you must create a Helm Values file, called akamas.yaml
in this guide, containing the mandatory configuration values required to customize your application. The following template contains the minimal set required to install Akamas:
Replace in the file the following placeholders:
CUSTOMER_NAME
: customer name provided with the Akamas licenseADMIN_PASSWORD
: initial administrator passwordINSTANCE_HOSTNAME
: the URL that will be used to expose the Akamas installation, for examplehttps://akamas.k8s.example.com
when using an Ingress, orhttp//:localhost:9000
when using port-forwarding. Refer to Accessing Akamas for the list of the supported access methods and a reference for any additional configuration required.REGISTRY_URL
: the URL for the private registry used in the transfer process above
Configure the authentication
This section describes how to configure the authentication to your private registry. If your registry does not require any authentication, skip directly to the installation section.
To authenticate to your private registry, you must manually create the Secret required to pull the images. If the registry uses basic authentication, you can create the credentials in the namespace by running the following command:
Otherwise, you can leverage any credential already configured on your machine by running the following command:
Start the installation
From a machine that can reach the endpoint, run the following command to download the chart:
The command downloads the latest version chart version as an archive named akamas-<version>.tgz
. The file can be transferred to the machine where the installation will be run. Replace akamas/akamas
with the download package in the following commands.
If you wish to see and override the values that Helm will use to install Akamas, you may execute the following command.
Now, with the configuration file you just created (and the new variables you added to override the defaults), you can start the installation with the following command:
This command will create the Akamas resources within the specified namespace. You can define a different namespace by changing the argument --namespace <your-namespace>
An example output of a successful installation is the following:
Check the installation
To monitor the application startup, run the command kubectl get pods
. After a few minutes, the expected output should be similar to the following:
At this point, you should be able to access the Akamas UI using the endpoint specified in the akamasBaseUrl
, and interact through the Akamas CLI with the path /akapi
.
If you haven't already, you can update your configuration file to use a different type of service to expose Akamas' endpoints. To do so, pick from the Accessing Akamas the configuration snippet for the service type of your choice, add it to the akamas.yaml
file, update the akamasBaseUrl
value, and re-run the installation command to update your Helm release.
Last updated