Commit babf286e authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

updated deployment instructions

parent 284f7ca8

README.md

+27 −12
Original line number Diff line number Diff line
@@ -81,6 +81,26 @@ Build and deploy the MEC Sandbox as follows: 
     - Clone AdvantEDGE repo to the MEC Sandbox deployment VM

     - Place repo in home folder

     - Checkout the required AdvantEDGE version tag

1. Configure MEC Sandbox:

   - Configure session & OAuth secrets:

     - `vi ~/mec-sandbox/config/secrets.yaml`

       - Set a unique session encryption key

       - Set the OAuth provider client ID & secrets using the values from the OAuth Applications

   - Configure Alert Manager slack channel webhook:

     - Create incoming webhook:

       - Create target slack channel in slack workspace

       - Go to `Manage Apps` in workspace settings

       - Search for `Incoming Webhooks` app

       - Click `Add to Slack`

         - **NOTE:** The webhook url can be found by looking at the app configuration

       - Choose a slack channel to post messages to

       - Click `Add Incoming WebHooks integration`

       - Copy the `Webhook URL`

       - **NOTE:** There should be a message in the selected slack channel indicating that an incoming webhook has be added 

     - Set webhook url in Prometheus values override:

       - `vi ~/mec-sandbox/config/values/meep-prometheus.yaml`

       - Set `slack_api_url` to your slack channel webhook url

       - Set `channel` to your slack channel

1. Build & Deploy STF Frontend:

   - SSH to MEC Sandbox deployment VM

   - Build STF Frontend:
@@ -89,19 +109,14 @@ Build and deploy the MEC Sandbox as follows: 
   - Deploy STF Frontend & Configuration files:

     - `./deploy.sh`

     - **NOTE:** This updates the `~/.meep/user/` folder with the user frontend, sandbox swagger UI, and user chart values.yaml overrides

1. Configure AdvantEDGE:

   - Update deployment config & permissions files (from MEC Sandbox):

     - `cp ~/mec-sandbox/config/.meepctl-repocfg.yaml ~/AdvantEDGE/.meepctl-repocfg.yaml`

       - **NOTE:** Verify the Deployment config section values before deploying the platform

     - `cp ~/mec-sandbox/config/permissions.yaml ~/AdvantEDGE/config/permissions.yaml`

   - Configure session & OAuth secrets:

     - `vi ~/AdvantEDGE/config/secrets.yaml`

       - Set a unique session encryption key

       - Set the OAuth provider client ID & secrets using the values from the OAuth Applications

     - **NOTE:** This also copies the AdvantEDGE configuration files to their respective locations in your local AdvantEDGE clone `~/AdvantEDGE/`. Running `git status` in your AdvantEDGE clone will list the updated (or new) files.

1. Create Session & OAuth Secrets:

   - Install Python2: `sudo apt install python-minimal`

   - Install Python-pip: `sudo apt install python-pip`

   - Install Pyyaml: `pip install pyyaml`

   - Create secrets:

     - `python ~/AdvantEDGE/config/configure-secrets.py set ~/AdvantEDGE/config/secrets.yaml`

       - To install Python2: `sudo apt install python-minimal`

       - To install Python-pip: `sudo apt install python-pip`

       - **NOTE:** Once the kuberentes secrets have been created, it is recommended to remove the `~/AdvantEDGE/config/secrets.yaml` file containing the clear-text secrets

     - **NOTE:** Once the kuberentes secrets have been created, it is recommended to remove the `secrets.yaml` config files containing the clear-text secrets

1. Build & Deploy AdvantEDGE:

   - Build meepctl:

     - `~/AdvantEDGE/go-apps/meepctl/install.sh`