Skip to main content

Installing AtScale

The following sections describe how to install the AtScale Helm chart.

note

If needed, you can download the AtScale images prior to installing. For the full list of images for a particular release, refer to the release notes.

Prerequisites​

Before you can install AtScale, you must have the following:

  • A Kubernetes cluster that meets the requirements described in System Requirements.

    Need help getting started?

    For guidance on creating a Kubernetes cluster, refer to the AtScale K8S Blueprints repository on GitHub. This repository provides the infrastructure needed to create a Kubernetes environment from scratch, and walks you through the process of getting set up. In the end, you will have an environment with the default configurations to deploy AtScale applications correctly.

  • Helm 3+ installed.

  • A TLS certificate. This is required even if you do not enable TLS for AtScale. The certificate can be self-signed and does not need to be valid.

  • RBAC authentication enabled on your cluster and cluster permissions configured, as described in Configuring Cluster Permissions.

  • Volume resizing enabled on your cluster, as described in Enabling Volume Resizing.

  • A values override file. For more information, see Creating a Values Override File.

Install AtScale​

Once you have any necessary configuration defined, you can install AtScale. Open a terminal window and run the following:

helm install atscale oci://docker.io/atscaleinc/atscale --version <version> -n <namespace> --create-namespace -f <override_file>

Where:

  • <version> is the version of AtScale to install; for example, 2024.1.1.
  • <namespace> is the namespace in which you want to install AtScale.
  • <override_file> is the values override file you created above.

For example:

helm install atscale oci://docker.io/atscaleinc/atscale --version 2024.9.0 -n atscale --create-namespace -f ./values.yaml

Configure your DNS​

After installing AtScale, you must configure your DNS. This will require either the IP address or hostname of the atscale service.

To obtain this information, open a terminal window and run the following command:

kubectl get service -n <atscale_namespace> atscale-proxy

You can then use the returned value to create either an A record (if the value is an IP address) or a CNAME record (if the value is a hostname).

Next Steps​

Once you have AtScale up and running, you should do the following: