blob: 00ef5fccc913cf16389ce26af695f490fdb0036c [file] [log] [blame]
Hung-Wei Chiu77c969e2020-10-23 18:13:07 +00001..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
Hyunsun Moon049b5052021-07-30 12:41:03 -07005Runtime Deployment
6==================
Zack Williams794532a2021-03-18 17:38:36 -07007
Hyunsun Moon049b5052021-07-30 12:41:03 -07008This section describes how to configure and install Aether edge runtime including K8S
9and system level resources.
10We will be using GitOps based Aether CI/CD system for this and what you need to do is
11create a patch to Aether GitOps repository, **aether-pod-configs**, with the edge
12specific information.
13
14.. attention::
15
16 If you skipped VPN bootstap step and didn't add the deployment jobs for the new edge,
17 go to :ref:`Add deployment jobs <add_deployment_jobs>` step and finish it first
18 before proceeding.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070019
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070020Download aether-pod-configs repository
Zack Williams794532a2021-03-18 17:38:36 -070021--------------------------------------
22
Hyunsun Moon049b5052021-07-30 12:41:03 -070023Download ``aether-pod-configs`` repository if you don't have it already in
Zack Williams794532a2021-03-18 17:38:36 -070024your development machine.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070025
26.. code-block:: shell
27
28 $ cd $WORKDIR
29 $ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-pod-configs"
30
Hyunsun Moon049b5052021-07-30 12:41:03 -070031.. _create_cluster_configs:
32
33Create cluster configurations
34-----------------------------
Zack Williams794532a2021-03-18 17:38:36 -070035
Hyunsun Moon5c1e0b02020-11-20 11:09:00 -080036.. attention::
37
Hyunsun Moon049b5052021-07-30 12:41:03 -070038 If you skipped VPN bootstap step and didn't update global resource maps for the new edge,
39 go to :ref:`Update global resource maps <update_global_resource>` step and
40 finish ``cluster_map.tfvars`` and ``user_map.tfvars`` update first before proceeding.
Zack Williams794532a2021-03-18 17:38:36 -070041
Hyunsun Moona703edf2021-07-29 15:55:15 -070042Run the following commands to auto-generate Terraform configurations needed to
Hyunsun Moon049b5052021-07-30 12:41:03 -070043create a new cluster in `Rancher <https://rancher.aetherproject.org>`_ and add servers and
44switches to the cluster.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070045
46.. code-block:: shell
47
Hyunsun Moona703edf2021-07-29 15:55:15 -070048 # Create ace_cofig.yaml file if you haven't yet
Hyunsun Moona79c7422020-11-18 04:52:56 -080049 $ cd $WORKDIR/aether-pod-configs/tools
Hyunsun Moona703edf2021-07-29 15:55:15 -070050 $ cp ace_config.yaml.example ace_config.yaml
51 $ vi ace_config.yaml
52 # Set all values
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070053
Hyunsun Moona79c7422020-11-18 04:52:56 -080054 $ make runtime
Hyunsun Moona703edf2021-07-29 15:55:15 -070055 Created ../production/ace-test/provider.tf
Hyunsun Moon049b5052021-07-30 12:41:03 -070056 Created ../production/ace-test/cluster.tf
Hyunsun Moona703edf2021-07-29 15:55:15 -070057 Created ../production/ace-test/rke-bare-metal.tf
58 Created ../production/ace-test/addon-manifests.yml.tpl
59 Created ../production/ace-test/project.tf
Hyunsun Moon049b5052021-07-30 12:41:03 -070060 Created ../production/ace-test/member.tf
61 Created ../production/ace-test/backend.tf
62 Created ../production/ace-test/cluster_val.tfvars
Hyunsun Moona703edf2021-07-29 15:55:15 -070063
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070064
Hyunsun Moon049b5052021-07-30 12:41:03 -070065Commit your change
66------------------
67
68Lastly, create a review request with the changes.
69Once your review request is accepted and merged, the post-merge job will start to deploy K8S at the edge.
70Wait until the cluster is **Active** status in `Rancher <https://rancher.aetherproject.org>`_.
Zack Williams794532a2021-03-18 17:38:36 -070071
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070072.. code-block:: shell
73
Hyunsun Moona79c7422020-11-18 04:52:56 -080074 $ cd $WORKDIR/aether-pod-configs
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070075 $ git status
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070076 $ git add .
Hyunsun Moona79c7422020-11-18 04:52:56 -080077 $ git commit -m "Add test ACE runtime configs"
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070078 $ git review