docs(orc8r): Adding Deploy Orchestrator using Ansible docs#15166
docs(orc8r): Adding Deploy Orchestrator using Ansible docs#15166wendallkaters merged 8 commits intomagma:masterfrom
Conversation
Signed-off-by: Shubham Tatvamasi <[email protected]>
|
Thanks for opening a PR! 💯
Howto
More infoPlease take a moment to read through the Magma project's
If this is your first Magma PR, also consider reading
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| # Deploy Orchestrator using Ansible (Beta) | ||
|
|
||
| This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
|
|
||
| ## Pre-requisites | ||
|
|
||
| - Ubuntu Jammy 22.04 VM / Baremetal machine |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
| - CPU: 4 cores | ||
| - Storage: 100GB | ||
|
|
||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
|
|
||
|
|
||
| Quick Install: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ``` | ||
|
|
||
| Switch to `magma` user after deployment has finsished: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ``` | ||
|
|
||
| Once all pods are ready, setup NMS login: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ``` | ||
|
|
||
| You can get your `rootCA.pem` file from the following location: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
|
|
||
| # Deploy Orchestrator using Ansible (Beta) | ||
|
|
||
| This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment. |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment. | |
| This how-to guide can be used to deploy Magma's Orchestrator on any cloud environment. |
|
|
||
| ## Pre-requisites | ||
|
|
||
| - Ubuntu Jammy 22.04 VM / Baremetal machine |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| - Ubuntu Jammy 22.04 VM / Baremetal machine | |
| - Ubuntu Jammy 22.04 VM / Baremetal machine |
| - CPU: 4 cores | ||
| - Storage: 100GB | ||
|
|
||
|
|
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
|
|
||
|
|
||
| Quick Install: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ```bash | |
| ```bash |
| ``` | ||
|
|
||
| Switch to `magma` user after deployment has finsished: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ```bash | |
| ```bash |
| ``` | ||
|
|
||
| Once all pods are ready, setup NMS login: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ```bash | |
| ```bash |
| ``` | ||
|
|
||
| You can get your `rootCA.pem` file from the following location: | ||
| ```bash |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ```bash | |
| ```bash |
|
Oops! Looks like you failed the Howto
♻️ Updated: ❌ The check is still failing the Docs Lint & Check Generated Files In Sync after the last commit. |
Signed-off-by: Shubham Tatvamasi <[email protected]>
| ## Deploy Orchestrator | ||
|
|
||
| Quick Install: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ## Deploy Orchestrator | ||
|
|
||
| Quick Install: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` | ||
|
|
||
| Switch to `magma` user after deployment has finsished: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` | ||
|
|
||
| Switch to `magma` user after deployment has finsished: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` | ||
|
|
||
| Check if all pods are ready | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` | ||
| > Replace the IP address with the one you see in `kubectl get nodes -o wide` | ||
|
|
||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
|
|
||
| You can access NMS at the following URL: | ||
|
|
||
| https://magma-test.nms.magma.local |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD034/no-bare-urls Bare URL used [Context: "https://magma-test.nms.magma.l..."]
|
|
||
| https://magma-test.nms.magma.local | ||
|
|
||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
|
|
||
|
|
||
| You can get your `rootCA.pem` file from the following location: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
|
|
||
|
|
||
| You can get your `rootCA.pem` file from the following location: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ## Deploy Orchestrator | ||
|
|
||
| Quick Install: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| ``` | ||
|
|
||
| Switch to `magma` user after deployment has finsished: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| ``` | ||
|
|
||
| Check if all pods are ready | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| ``` | ||
|
|
||
| setup NMS login: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| ``` | ||
|
|
||
| Update `/etc/hosts` file with the following entries: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| 10.86.113.153 controller.magma.local | ||
| 10.86.113.153 bootstrapper-controller.magma.local | ||
| ``` | ||
| > Replace the IP address with the one you see in `kubectl get nodes -o wide` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| > Replace the IP address with the one you see in `kubectl get nodes -o wide` |
| ``` | ||
| > Replace the IP address with the one you see in `kubectl get nodes -o wide` | ||
|
|
||
|
|
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| > Replace the IP address with the one you see in `kubectl get nodes -o wide` | |
| https://magma-test.nms.magma.local | ||
|
|
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| https://magma-test.nms.magma.local | |
| <https://magma-test.nms.magma.local> |
|
|
||
|
|
||
| You can get your `rootCA.pem` file from the following location: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
Signed-off-by: Shubham Tatvamasi <[email protected]>
| ``` | ||
|
|
||
| Update `/var/opt/magma/configs/control_proxy.yml` file with the following content: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` | ||
|
|
||
| Update `/var/opt/magma/configs/control_proxy.yml` file with the following content: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` | ||
|
|
||
| Update `/var/opt/magma/configs/control_proxy.yml` file with the following content: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
Signed-off-by: Shubham Tatvamasi <[email protected]>
pull-request-size
bot
added
size/L
| kubectl get pods | ||
| ``` | ||
|
|
||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
Signed-off-by: Shubham Tatvamasi <[email protected]>
Signed-off-by: Shubham Tatvamasi <[email protected]>
| ``` | ||
| > Replace the External IP address with the one you see in `kubectl get svc haproxy` | ||
|
|
||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` | ||
|
|
||
| Update `/etc/hosts` file in Access Gateway with the following entries: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` | ||
|
|
||
| Update `/etc/hosts` file in Access Gateway with the following entries: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| 10.86.113.153 controller.magma.local | ||
| 10.86.113.153 bootstrapper-controller.magma.local | ||
| ``` | ||
| > Replace the External IP address with the one you see in `kubectl get svc haproxy` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| > Replace the External IP address with the one you see in `kubectl get svc haproxy` | |
| > Replace the External IP address with the one you see in `kubectl get svc haproxy` |
| ``` | ||
|
|
||
| Update `/etc/hosts` file in Access Gateway with the following entries: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
Signed-off-by: Shubham Tatvamasi <[email protected]>
| ``` | ||
|
|
||
| Following roles will be installed: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` | ||
|
|
||
| Following roles will be installed: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ## DNS Setup | ||
|
|
||
| Get the External IP address of the `haproxy` service: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ## DNS Setup | ||
|
|
||
| Get the External IP address of the `haproxy` service: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| kubectl get svc haproxy | ||
| ``` | ||
|
|
||
| ``` |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` | ||
|
|
||
| Following roles will be installed: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| ## DNS Setup | ||
|
|
||
| Get the External IP address of the `haproxy` service: | ||
| ``` |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| ``` | |
| ``` |
| 10.86.113.153 controller.magma.local | ||
| 10.86.113.153 bootstrapper-controller.magma.local | ||
| ``` | ||
| > Replace the External IP with the one you got from the previous step. |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| > Replace the External IP with the one you got from the previous step. | |
| > Replace the External IP with the one you got from the previous step. |
Signed-off-by: Shubham Tatvamasi <[email protected]>
* docs(orc8r): Adding Deploy Orchestrator using Ansible docs Signed-off-by: Shubham Tatvamasi <[email protected]> * Added more content Signed-off-by: Shubham Tatvamasi <[email protected]> * Added AGW Signed-off-by: Shubham Tatvamasi <[email protected]> * Added k8s commands Signed-off-by: Shubham Tatvamasi <[email protected]> * minor docs fix Signed-off-by: Shubham Tatvamasi <[email protected]> * Added DNS Signed-off-by: Shubham Tatvamasi <[email protected]> * Added roles output Signed-off-by: Shubham Tatvamasi <[email protected]> * lint fix Signed-off-by: Shubham Tatvamasi <[email protected]> --------- Signed-off-by: Shubham Tatvamasi <[email protected]>
3 participants
Summary
Test Plan
Additional Information
Security Considerations