Skip to content

Latest commit

 

History

History
135 lines (99 loc) · 6.1 KB

DockerUsage.md

File metadata and controls

135 lines (99 loc) · 6.1 KB
Raw

Using Docker Container

Prereqs

Preparation

Docker image

Run the following command to create the viya4-deployment Docker image using the provided Dockerfile

docker build -t viya4-deployment .

The Docker image viya4-deployment will contain ansible, cloud provider cli's and 'kubectl' executables. The Docker entrypoint for the image is ansible-playbook that will be run with sub-commands in the subsequent steps.

Cloud Authentication

The docker container includes the necessary cloud clis for interacting with the cloud providers. See ansible cloud authentication when deploying to GCP with external postgres

Docker Volume Mounts

All configs needed by ansible are also needed to be mounted into the docker container. In general any file/folder path set via an ansible flag are equivalent to the file/folder being mounted to the docker container at /config/<lower_case_variable_name>.

See Docker Volume Mapping for the full list of docker volume mappings.

Examples:

  • The ansible flag -e KUBECONFIG is equivalent to --volume <desire_path>:/config/kubeconfig when running the docker container
  • The ansible flag -e JUMP_SVR_PRIVATE_KEY is equivalent to --volume <desire_path>:/config/jump_svr_private_key when running the docker container
  • The ansible flag -e V4_CFG_SITEDEFAULT is equivalent to --volume <desire_path>:/config/v4_cfg_sitedefault when running the docker container

Below are the only exceptions:

Ansible Flag Docker Mount Path Description Required
-e BASE_DIR /data local folder in which all the generated files can be stored. If you do not wish to save the files, this can be omitted false
--vault-password-file /config/vault_password_file Full path to file containing the Ansible vault password false

Variable Definitions (ansible-vars.yaml) File

Prepare your ansible-vars.yaml file, as described in Customize Input Values.

Running

Declare the Actions and Task to be performed

Actions

Actions are used to install or uninstall software. One must be set when running the playbook.

Name Description
Install Installs the stack required for the specified tasks
Uninstall Uninstalls the stack required for the specified tasks

Tasks

Any number of tasks can be run at the same time. An action can run against a single task or all tasks.

Name Description
baseline Installs cluster level tooling needed for all viya deployments. These may include, cert-manager, ingress-nginx, nfs-client-provisioners and more.
viya Deploys viya
cluster-logging Installs cluster-wide logging using the viya4-monitoring-kubernetes project.
cluster-monitoring Installs cluster-wide monitoring using the viya4-monitoring-kubernetes project.
viya-monitoring Installs viya namespace level monitoring using the viya4-monitoring-kubernetes project.

Examples

  • I have a new cluster, deployed using one of the Viya4 IAC projects, and want to install everything

    docker run --rm \
  --group-add root \
  --user $(id -u):$(id -g) \
  --volume $HOME/deployments:/data \
  --volume $HOME/deployments/dev-cluster/dev-namespace/ansible-vars.yaml:/config/config \
  --volume $HOME/deployments/dev-cluster/terraform.tfstate:/config/tfstate \
  --volume $HOME/.ssh/id_rsa:/config/jump_svr_private_key \
  viya4-deployment --tags "baseline,viya,cluster-logging,cluster-monitoring,viya-monitoring,install"

  • I have a custom built cluster and want to baseline and deploy viya only

    docker run --rm \
  --group-add root \
  --user $(id -u):$(id -g) \
  --volume $HOME/deployments:/data \
  --volume $HOME/deployments/dev-cluster/.kube/config:/config/kubeconfig \
  --volume $HOME/deployments/dev-cluster/dev-namespace/ansible-vars.yaml:/config/config \
  --volume $HOME/.ssh/id_rsa:/config/jump_svr_private_key \
  viya4-deployment --tags "baseline,viya,install"

  • I want to modify a customization under site-config for an existing viya deployment and reapply the manifest. I wish to continue to use the same deployment assets rather than pull the latest copy.

    docker run --rm \
  --group-add root \
  --user $(id -u):$(id -g) \
  --volume $HOME/deployments:/data \
  --volume $HOME/deployments/dev-cluster/dev-namespace/ansible-vars.yaml:/config/config \
  --volume $HOME/deployments/dev-cluster/terraform.tfstate:/config/tfstate \
  --volume $HOME/deployments/dev-cluster/dev-namespace/deployment_assets.tgz:/config/v4_cfg_deployment_assets \
  --volume $HOME/.ssh/id_rsa:/config/jump_svr_private_key \
  viya4-deployment --tags "viya,install"

  • I have an existing cluster with viya installed and want to install another viya instance in a different namespace with monitoring

    docker run --rm \
  --group-add root \
  --user $(id -u):$(id -g) \
  --volume $HOME/deployments:/data \
  --volume $HOME/deployments/dev-cluster/test-namespace/ansible-vars.yaml:/config/config \
  --volume $HOME/deployments/dev-cluster/.ssh/id_rsa:/config/jump_svr_private_key \
  --volume $HOME/deployments/dev-cluster/.kube/config:/config/kubeconfig \
  viya4-deployment --tags "viya,viya-monitoring,install"

  • I have a cluster with a single viya install as well as the monitoring and logging stack. I want to uninstall everything

    docker run --rm \
  --group-add root \
  --user $(id -u):$(id -g) \
  --volume $HOME/deployments:/data \
  --volume $HOME/deployments/dev-cluster/dev-namespace/ansible-vars.yaml:/config/config \
  --volume $HOME/deployments/dev-cluster/terraform.tfstate:/config/tfstate \
  viya4-deployment --tags "baseline,viya,cluster-logging,cluster-monitoring,viya-monitoring,uninstall"