AETHER-2031 Update VPN bootstrap and runtime deployment guide
Change-Id: I66aeaecb9c25bb542acd5fd71cd01d2dd3cb00e1
diff --git a/edge_deployment/runtime_deployment.rst b/edge_deployment/runtime_deployment.rst
index c97f55d..96fa059 100644
--- a/edge_deployment/runtime_deployment.rst
+++ b/edge_deployment/runtime_deployment.rst
@@ -5,11 +5,10 @@
Aether Runtime Deployment
=========================
-This section describes how to install Aether edge runtime and Aether managed
-applications.
-
-We will be using GitOps based Aether CD pipeline for this, so we just need to
-create a patch to **aether-pod-configs** repository.
+This section describes how to install Aether edge runtime and Aether managed applications
+including monitoring and logging system, as well as User Plane Function(UPF).
+We will be using GitOps based Aether CI/CD system for this and all you need to do is to
+create several patches to Aether GitOps repositories.
Download aether-pod-configs repository
--------------------------------------
@@ -27,7 +26,8 @@
.. attention::
- Skip this section if you have already done the same step in the
+ Skip this section and go to :ref:`Create runtime configurations <create_runtime_configs>`
+ if you have already done the same in the
:ref:`Update Global Resources Map for VPN <update_global_resource>` section.
Add a new ACE information at the end of the following global resource maps.
@@ -77,11 +77,11 @@
+ },
+ ace-test = {
+ cluster_name = "ace-test"
- + management_subnets = ["10.91.0.0/24"]
+ + management_subnets = ["10.32.4.0/24"]
+ k8s_version = "v1.18.8-rancher1-1"
- + k8s_pod_range = "10.66.0.0/17"
- + k8s_cluster_ip_range = "10.66.128.0/17"
- + kube_dns_cluster_ip = "10.66.128.10"
+ + k8s_pod_range = "10.33.0.0/17"
+ + k8s_cluster_ip_range = "10.33.128.0/17"
+ + kube_dns_cluster_ip = "10.33.128.10"
+ cluster_domain = "prd.test.aetherproject.net"
+ calico_ip_detect_method = "can-reach=www.google.com"
}
@@ -103,35 +103,29 @@
$ git commit -m "Add test ACE"
$ git review
+.. _create_runtime_configs:
+
Create runtime configurations
-----------------------------
-In this step, we will add several Terraform configurations and overriding
-values for the managed applications.
-
-Run the following commands to auto-generate necessary files under the target
-ACE directory.
+Run the following commands to auto-generate Terraform configurations needed to
+create K8S cluster in Rancher and add servers and switches to the cluster.
.. code-block:: shell
+ # Create ace_cofig.yaml file if you haven't yet
$ cd $WORKDIR/aether-pod-configs/tools
- $ cp ace_env /tmp/ace_env
- $ vi /tmp/ace_env
- # Set environment variables
+ $ cp ace_config.yaml.example ace_config.yaml
+ $ vi ace_config.yaml
+ # Set all values
- $ source /tmp/ace_env
$ make runtime
- Created ../production/ace-test
- Created ../production/ace-test/main.tf
- Created ../production/ace-test/variables.tf
- Created ../production/ace-test/gcp_fw.tf
- Created ../production/ace-test/cluster.tf
- Created ../production/ace-test/alerts.tf
- Created ../production/ace-test/backend.tf
- Created ../production/ace-test/cluster_val.tfvars
- Created ../production/ace-test/app_values
- Created ../production/ace-test/app_values/ace-coredns.yml
- Created ../production/ace-test/app_values/omec-upf-pfcp-agent.yml
+ Created ../production/ace-test/provider.tf
+ Created ../production/ace-test/member.tf
+ Created ../production/ace-test/rke-bare-metal.tf
+ Created ../production/ace-test/addon-manifests.yml.tpl
+ Created ../production/ace-test/project.tf
+
Create a review request
-----------------------
@@ -140,17 +134,9 @@
$ cd $WORKDIR/aether-pod-configs
$ git status
-
- Untracked files:
- (use "git add <file>..." to include in what will be committed)
-
- production/ace-test/alerts.tf
- production/ace-test/app_values/
- production/ace-test/cluster.tf
-
$ git add .
$ git commit -m "Add test ACE runtime configs"
$ git review
-Once the review request is accepted and merged,
-CD pipeline will start to deploy K8S and Aether managed applications on it.
+Once the review request is accepted and merged, the post-merge job will start to deploy K8S.
+Wait until the cluster is **Active** status in Rancher.