Skip to main content

Install ArconQ (from Linux)

note

Before you start make sure that:

  • Your Kubernetes cluster is up and running.
  • kubectl and helm commands are installed and have access to the cluster.
  • You have added ArconQ Helm Registry to your Helm well-known registries list.
  • You have obtained your ArconQ Docker Registry user credentials.
  • You have obtained your ArconQ license token.

Install ArconQ Helm chart​

In order to install ArconQ distribution via Helm chart it is generally only required to run helm upgrade command providing all necessary configuration parameters.

Basic installation​

Following command will install latest stable ArconQ version using default ArconQ configuration.

helm upgrade arconq-release arconq/arconq \
  --install \
  --atomic \
  --cleanup-on-fail \
  --create-namespace \
  --namespace arconq \
  --set arconq.host=arconq.prod \
  --set arconq.docker.registryUrl="$ARQ_DOCKER_URL" \
  --set arconq.docker.username="$ARQ_DOCKER_USER" \
  --set arconq.docker.password="$ARQ_DOCKER_PASSWORD" \
  --set arconq.license.token="$ARQ_LICENSE_TOKEN"

Where:

  • arconq-release is Helm chart release name. This name is up to you and allows you to distinguish between multiple ArconQ instances installed by Helm.
  • arconq.prod is the ArconQ URL.
  • arconq/arconq is the Helm chart name. In this case it refers to the arconq chart in arconq repository.
  • $ARQ_DOCKER_URL is the URL of ArconQ Docker Registry.
  • $ARQ_DOCKER_USER is your user name for ArconQ Docker Registry.
  • $ARQ_DOCKER_PASSWORD is your user password for ArconQ Docker Registry.
  • $ARQ_LICENSE_TOKEN is your base64-encoded ArconQ license token.

Once the installation is finished you can access your ArconQ instance at http://arconq.prod

Configuring ArconQ installation​

Before you install ArconQ a few decisions are to be made.

ArconQ license token​

A valid license token is required during installation. The token is provided as a base64-encoded string via the arconq.license.token parameter.

Contact your ArconQ administrator or account manager to obtain the license token.

note

During helm upgrade, the license token is optional — if omitted, the token stored from the previous installation is preserved automatically. Providing a new value during upgrade will replace the existing token.

ArconQ host name​

You need to define your ArconQ installation host name. In this manual arconq.prod is used.

Ingress TLS certificate​

In order to use SSL you have to configure TLS certificate. You can provide own TLS certificate during ArconQ installation. Also, you can also create the TLS Secret manually in your cluster and provide its name during installation. The Secret will be used by ArconQ Ingress.

If you do not have the certificate, there are following ways to obtain it:

  • You can use the cert-manager to automatically obtain TLS certificate after installation. This requires cert-manager to be installed and configured in your cluster, moreover ArconQ instance must be accessible from the Internet.

Configure ArconQ TLS certificate​

You need to have TLS certificate generated for your installation. Contact our administrator in order to obtain it.

In next steps it is assumed your certificate file is named arconq.pfx.

Extract the certificate and print it base64-encoded:

openssl pkcs12 -in arconq.pfx -passin "pass:$PASSWORD" -clcerts -nokeys -out - -passout "pass:$PASSWORD" -legacy | openssl x509 -out arconq.crt
base64 arconq.crt

Extract the cerfiticate key and print it base64-encoded:

openssl pkcs12 -in arconq.pfx -passin "pass:$PASSWORD" -nocerts -nodes -out - -passout "pass:$PASSWORD" -legacy | openssl rsa -out arconq.key
base64 arconq.key

Putting everything all together​

Following command will install ArconQ with all discussed parameters.

helm upgrade arconq-release arconq/arconq \
  --install \
  --atomic \
  --cleanup-on-fail \
  --create-namespace \
  --namespace arconq \
  --set arconq.host=arconq.prod \
  --set arconq.docker.registryUrl="$ARQ_DOCKER_URL" \
  --set arconq.docker.username="$ARQ_DOCKER_USER" \
  --set arconq.docker.password="$ARQ_DOCKER_PASSWORD" \
  --set arconq.license.token="$ARQ_LICENSE_TOKEN" \
  --set ingress.tls.certificate="$(base64 -w0 certificate.crt)" \
  --set ingress.tls.certificateKey="$(base64 -w0 private_key.key)"

Installing older ArconQ release​

If you wish to install older ArconQ release, you should find the Helm chart version that you are interested in. 

helm repo update
helm search repo arconq --devel --versions
NAME            CHART VERSION   APP VERSION     DESCRIPTION
arconq/arconq   1.0.0-rc9       1.0.0-rc7       ArconQ Runtime
arconq/arconq   1.0.0-rc8       1.0.0-rc6       ArconQ Runtime
arconq/arconq   1.0.0-rc7       1.0.0-rc6       ArconQ Runtime
arconq/arconq   1.0.0-rc6       1.0.0-rc5       ArconQ Runtime
arconq/arconq   1.0.0-rc5       1.0.0-rc4       ArconQ Runtime
arconq/arconq   1.0.0-rc4       1.0.0-rc3       ArconQ Runtime
arconq/arconq   1.0.0-rc17      1.0.0-rc12      ArconQ Runtime
arconq/arconq   1.0.0-rc16      1.0.0-rc11      ArconQ Runtime
note

Helm chart version (CHART VERSION) is not the same as ArconQ version (APP VERSION). Make sure you provide Helm chart version to helm upgrade command.

To install selected ArconQ version provide the CHART VERSION to helm upgrade by --version parameter.