blob: d4e70a3fa2191043367921c8340233e044ff151a [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
5==========================
6Aether Run-Time Deployment
7==========================
Hyunsun Moona79c7422020-11-18 04:52:56 -08008This section describes how to install Aether edge runtime and Aether managed applications.
9We will be using GitOps based Aether CD pipeline for this,
10so we just need to create a patch to **aether-pod-configs** repository.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070011
12Before you begin
13================
Hyunsun Moona79c7422020-11-18 04:52:56 -080014Make sure :doc:`Bootstrapping <bootstrapping>` **Update global resource maps** section is completed.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070015
16Download aether-pod-configs repository
17======================================
Hyunsun Moona79c7422020-11-18 04:52:56 -080018Download aether-pod-configs repository if you don't have it in your develop machine.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070019
20.. code-block:: shell
21
22 $ cd $WORKDIR
23 $ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-pod-configs"
24
Hyunsun Moona79c7422020-11-18 04:52:56 -080025Create runtime configurations
26=============================
27In this step, we will add several Terraform configurations and overriding values for the managed applications.
28Run the following commands to auto-generate necessary files under the target ACE directory.
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070029
30.. code-block:: shell
31
Hyunsun Moona79c7422020-11-18 04:52:56 -080032 $ cd $WORKDIR/aether-pod-configs/tools
33 $ vi ace_env
34 # Set environment variables
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070035
Hyunsun Moona79c7422020-11-18 04:52:56 -080036 $ source ace_env
37 $ make runtime
38 Created ../production/ace-test/main.tf
39 Created ../production/ace-test/variables.tf
40 Created ../production/ace-test/cluster.tf
41 Created ../production/ace-test/alerts.tf
42 Created ../production/ace-test/app_values/ace-coredns.yml
43 Created ../production/ace-test/app_values/omec-upf-pfcp-agent.yml
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070044
45Create a review request
Hyunsun Moona79c7422020-11-18 04:52:56 -080046=======================
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070047.. code-block:: shell
48
Hyunsun Moona79c7422020-11-18 04:52:56 -080049 $ cd $WORKDIR/aether-pod-configs
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070050 $ git status
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070051
52 Untracked files:
53 (use "git add <file>..." to include in what will be committed)
54
Hyunsun Moona79c7422020-11-18 04:52:56 -080055 production/ace-test/alerts.tf
56 production/ace-test/app_values/
57 production/ace-test/cluster.tf
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070058
59 $ git add .
Hyunsun Moona79c7422020-11-18 04:52:56 -080060 $ git commit -m "Add test ACE runtime configs"
Hyunsun Moon5ca6bfb2020-10-29 22:29:12 -070061 $ git review
Hyunsun Moona79c7422020-11-18 04:52:56 -080062
63Once the review request is accepted and merged,
64CD pipeline will start to deploy K8S and Aether managed applications on it.