Skip to main content

Installing AtScale

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

Prerequisites​

Before you can install AtScale, you must meet the following requirements:

  • A Kubernetes cluster that meets the requirements described in System Requirements.
  • 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.

Create a values override file​

Before installing AtScale, you need to create a file containing any configuration settings that are specific to your system.

AtScale's configuration settings are defined in the values.yml file included in its Helm chart. If you need to change any settings from the defaults, you must create a new YAML file that contains only those settings and their new values. When you run the installer, the values defined in this file override the ones defined in values.yml.

note

Save your values override file after installing AtScale, as you may need it to update your configuration later. For more information, see Upgrading AtScale.

For a first-time install, AtScale recommends creating an override file with the following settings.

global:
  ingressDomain: subdomain.domain.com

  atscale:
    # Set the certificate for TLS deployment.
    # For deployment, include the certificate and key in base64 format.
    tls:
      # If you have a secret which you've created manually, define it here.
      # !Important: Defining existingSecret will override the tlsCrt and tlsKey
      existingSecret: ""
      tlsCrt: ""
      tlsKey: ""

The following table describes the recommended override settings.

SettingDescription
ingressDomainThe ingress domain for the AtScale cluster. If you enable TLS, this should be the same as the domain defined in your certificate (see tlsCrt below).
existingSecretYour manually-created TLS secret, if available. This needs to be of type kubernetes.io/tls. For more information, refer to the Kubernetes documentation. Note: Providing an existingSecret overrides any values specified for tlsCrt and tlsKey.
tlsCrtThe base64 encoded value of your TLS certificate file.
tlsKeyThe base64 encoded value of your TLS certificate key.

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. 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 nginx

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: