From 9ac2ecd9a04b070a6a4731a10256c433422f48ca Mon Sep 17 00:00:00 2001 From: Sreejith Punnapuzha Date: Wed, 3 Feb 2021 10:19:14 -0600 Subject: [PATCH] Update packages and documentation * update developer guide with necessary steps * update setup script with new packages Signed-off-by: Sreejith Punnapuzha Change-Id: I9930f3a626f744bcace63fe22210bb4153306ede --- docs/source/developers.md | 42 +++++++++++++++++++-------------------- tools/gate/00_setup.sh | 2 +- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/source/developers.md b/docs/source/developers.md index 242df2272..c0080bac5 100644 --- a/docs/source/developers.md +++ b/docs/source/developers.md @@ -197,28 +197,28 @@ Make sure the following conditions are met: 2. A Virtual Machine with 20 GB RAM, 4 vCPU and 60GB Disk and Ubuntu 18.04 Installed. 3. Clone the following repo - - git clone https://opendev.org/airship/airshipctl.git -4. Download test security key and add it to environment variable. +4. Install necessary packages and pre deployment setup + 1. ./tools/gate/00_setup.sh +5. Download test security key and add it to environment variable. - curl -fsSL -o /tmp/key.asc https://raw.githubusercontent.com/mozilla/sops/master/pgp/sops_functional_tests_key.asc - export SOPS_IMPORT_PGP="$(cat /tmp/key.asc)" - export SOPS_PGP_FP="FBC7B9E2A4F9289AC0C1D4843D16CEE4A27381B4" -5. Execute the following scripts one by one - 1. ./tools/gate/00_setup.sh - 2. ./tools/gate/10_build_gate.sh - 3. sudo -E ./tools/deployment/01_install_kubectl.sh - 4. sudo -E ./tools/deployment/21_systemwide_executable.sh - 5. sudo -E ./tools/deployment/22_test_configs.sh - 6. sudo -E ./tools/deployment/23_pull_documents.sh - 7. sudo -E ./tools/deployment/24_build_images.sh - 8. sudo -E ./tools/deployment/25_deploy_ephemeral_node.sh - 9. sudo -E ./tools/deployment/26_deploy_capi_ephemeral_node.sh - 10. sudo -E ./tools/deployment/30_deploy_controlplane.sh - 11. sudo -E ./tools/deployment/31_deploy_initinfra_target_node.sh - 12. sudo -E ./tools/deployment/32_cluster_init_target_node.sh - 13. sudo -E ./tools/deployment/33_cluster_move_target_node.sh - 14. sudo -E ./tools/deployment/34_deploy_worker_node.sh - 15. sudo -E ./tools/deployment/35_deploy_workload.sh +6. Execute the following scripts one by one + 1. ./tools/gate/10_build_gate.sh + 1. sudo -E ./tools/deployment/01_install_kubectl.sh + 1. sudo -E ./tools/deployment/22_test_configs.sh + 1. sudo -E ./tools/deployment/23_pull_documents.sh + 1. sudo -E ./tools/deployment/24_build_images.sh + 1. sudo -E ./tools/deployment/25_deploy_ephemeral_node.sh + 1. sudo -E ./tools/deployment/26_deploy_capi_ephemeral_node.sh + 1. sudo -E ./tools/deployment/30_deploy_controlplane.sh + 1. sudo -E ./tools/deployment/31_deploy_initinfra_target_node.sh + 1. sudo -E ./tools/deployment/32_cluster_init_target_node.sh + 1. sudo -E ./tools/deployment/33_cluster_move_target_node.sh + 1. sudo -E ./tools/deployment/34_deploy_worker_node.sh + 1. sudo -E ./tools/deployment/35_deploy_workload.sh -6. How to verify the ephemeral cluster and target cluster is deployed successfully +7. How to verify the ephemeral cluster and target cluster is deployed successfully Validate Ephemeral Cluster is Operational: ```Markdown kubectl --kubeconfig /home/user/.airship/kubeconfig --context ephemeral-cluster get pods --all-namespaces @@ -280,7 +280,7 @@ Make sure the following conditions are met: metal3 metal3-baremetal-operator-84f9df77fb-25h4w 3/3 Running 0 11m ``` -7. How to deploy Workloads +8. How to deploy Workloads Once the Target is Operational, Workloads can be deployed on the Target Cluster. A small demo workload can be deployed using ./tools/deployment/35_deploy_workload.sh.This demo includes ingress as a workload. To verify execute kubectl command as below: @@ -310,7 +310,7 @@ Make sure the following conditions are met: drwxrwxr-x 3 user user 4096 Nov 16 17:02 ingress/ -rw-rw-r-- 1 user user 23 Nov 16 17:02 kustomization.yaml ``` -8. In case the All-in-One-VM is restarted and the nested VMs do not get restarted automatically simply execute the below steps to make the Target Cluster up again. +9. In case the All-in-One-VM is restarted and the nested VMs do not get restarted automatically simply execute the below steps to make the Target Cluster up again. ```Markdown $ sudo virsh list --all Id Name State @@ -333,7 +333,7 @@ Make sure the following conditions are met: 4 air-worker-1 running ``` -9. In case the deployment needs to be cleaned and rerun again, run the below script. +10. In case the deployment needs to be cleaned and rerun again, run the below script. - sudo ./tools/deployment/clean.sh diff --git a/tools/gate/00_setup.sh b/tools/gate/00_setup.sh index ce8c036f0..2641a9f9d 100755 --- a/tools/gate/00_setup.sh +++ b/tools/gate/00_setup.sh @@ -33,7 +33,7 @@ envsubst <"${AIRSHIPCTL_WS}/tools/gate/config_template.yaml" > "$PLAYBOOK_CONFIG # use new version of ansible, Ubuntu has old one sudo apt update -sudo DEBIAN_FRONTEND=noninteractive apt -y install software-properties-common python3-pip +sudo DEBIAN_FRONTEND=noninteractive apt -y install software-properties-common python3-pip curl wget ca-certificates sudo DEBIAN_FRONTEND=noninteractive apt -y --no-install-recommends install docker.io make ANSIBLE_PACKAGES="ansible netaddr"