Skip to main content

Installing Commons

AHD Commons provides middleware and monitoring tools that are required by Grain.

Prerequisites​

warning

To install Commons, you'll need appropriate AWS IAM credentials from Smeup. If you don't have them yet, stop this installation process and come back once you do.

Installation​

To install Commons, connect to AHD VM via SSH and follow these steps:

1. Update Helm Repositories​

Update your Helm repositories to get the latest available chart versions.

helm repo update

2. Prepare Commons Configurations​

Using the nano text editor, create a configuration file named commons-values.yaml

nano commons-values.yaml

Inside the file, paste the following content:

ecrCredentials:
  # -- Access Key ID of the AWS IAM User
  accessKey: ""
  # -- Secret Access Key ID of the AWS IAM User
  secretKey: ""

csiDriverSmb:
  # -- Install SMB Driver, required for CIFS Mounts
  enabled: false

argo-cd:
  # -- Install ArgoCD
  enabled: true

Fill out the various fields:

  • ecrCredentials should be filled with the Access Key and Secret Key of the AWS IAM user given to you by Smeup.
  • csiDriverSmb.enabled should be set to true only if you need to use CIFS network mounts (e.g., from webup), otherwise leave it as false
  • argo-cd.enabled should be set to true to enable ArgoCD. Set to false only if you want to manage AHD VM from an existing ArgoCD (i.e. from an existing AHD VM with ArgoCD enabled)
info

To save a file while using the "nano" editor, use the command combination CTRL+x, then press y, and then Enter.

3. Install the Latest Version of Commons​

Install Commons:

helm install commons smartkit/commons --values commons-values.yaml

4. Validate Installation​

Check if everything is working correctly by running k get pod

You should see a pod called commons-ecr-first-job-<random-id> with the Status Completed.

smeup@smartkit:~$ k get pod
NAME                                                  READY   STATUS      RESTARTS         AGE
commons-ecr-first-job-zg2cs                           0/1     Completed   0                10s
info

If the pod status is Running or Pending, wait a few seconds before trying the k get pod command again.