Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update to deployment guide #315

Merged
merged 21 commits into from
Jul 7, 2021
Merged

docs: update to deployment guide #315

Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
23d0c8c
fix(#2265): validating a mojaloop deployment as described in the docu…
mdebarros Jun 10, 2021
77d8e4c
markdown lint issues
mdebarros Jun 11, 2021
1fdae75
Updated hosts in deployment guide
mdebarros Jun 11, 2021
e311118
Cleaning up deployment guide
mdebarros Jun 11, 2021
5415016
Updates to deployment guide
mdebarros Jun 11, 2021
8a76541
Added link to postman
mdebarros Jun 11, 2021
b5b4883
Same
mdebarros Jun 11, 2021
76addfe
Fix md lint issues
mdebarros Jun 11, 2021
a71660e
Updates
mdebarros Jun 11, 2021
605aa11
Some minor updates
mdebarros Jun 24, 2021
5878393
Moved "Kubernetes Concept" section from Mac install to main document
mdebarros Jun 24, 2021
86ff881
Updated deployment-guide for mac
mdebarros Jun 28, 2021
3c194e7
Updates to deployment guide
mdebarros Jun 28, 2021
9a54701
Merge branch 'master' of github.com:mojaloop/documentation into fix/#…
mdebarros Jun 28, 2021
c6996c1
Updates to deployment-guide
mdebarros Jul 2, 2021
c5fcc13
Merge branch 'master' into fix/#2265-validating-a-mojaloop-deployment…
mdebarros Jul 7, 2021
282d5dd
fix: #2265-validating-a-mojaloop-deployment-as-described-in-the-docum…
mdebarros Jul 7, 2021
43f4f34
updated build cache to use the "BuildNum" and not rely on the package…
mdebarros Jul 7, 2021
92b2b3e
changed .BuildNum to .Revision
mdebarros Jul 7, 2021
a6e59f6
doc: update to deployment guide
mdebarros Jul 7, 2021
279ae0d
Merge branch 'master' into fix/#2265-validating-a-mojaloop-deployment…
elnyry-sam-k Jul 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ jobs:
command: |
npm run gitbook:build
- save_cache:
key: build-cache-{{ checksum "package-lock.json" }}
key: build-cache-{{ .Revision }}
paths:
- _book

Expand Down Expand Up @@ -198,7 +198,7 @@ jobs:
echo 'export GIT_CI_EMAIL=$GIT_CI_EMAIL' >> $BASH_ENV
- restore_cache:
keys:
- build-cache-{{ checksum "package-lock.json" }}
- build-cache-{{ .Revision }}
- run:
<<: *defaults_git_identity_setup
- run:
Expand Down
5 changes: 4 additions & 1 deletion deployment-guide/local-setup-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ At this point the reader/implementer should be familiar with [Mojaloop's deploym
- [2. Kubernetes](#2-kubernetes)
- [2.1. MicroK8S](#21-microk8s)
- [2.2. Docker](#22-docker)
- [3. Continue with Deployment](#3-continue-with-deployment)

## 1. Environment recommendations

Expand Down Expand Up @@ -137,4 +138,6 @@ Docker is deployed as part of the MicroK8s installation. The docker daemon used
microk8s.docker ps
```

3. Continue setup and configuration from the Kubernetes Dashboard section in the [Mojaloop's deployment guide - 3.2. Kubernetes Admin Interfaces](./README.md#32-kubernetes-admin-interfaces) document.
## 3. Continue with Deployment

1. Continue setup and configuration from the [Mojaloop's deployment guide - 3.2. Kubernetes Admin Interfaces](./README.md#32-kubernetes-admin-interfaces) document.
15 changes: 9 additions & 6 deletions deployment-guide/local-setup-mac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ This document will provide guidelines to a technical capable resources to setup,

At this point the reader/implementer should be familiar with [Mojaloop's deployment guide](./README.md). Imported information is contained in that document and as such a prerequisite to this document.

* [Local Deployment](local-setup-mac.md#local-deployment)
* [Kubernetes](local-setup-mac.md#1-kubernetes)
* [Kubernetes Installation with Docker](local-setup-mac.md#11-kubernetes-installation-with-docker)
* [Kubernetes environment setup](local-setup-mac.md#12-kubernetes-environment-setup)

- [Mojaloop local environment setup for Mac](#mojaloop-local-environment-setup-for-mac)
- [Setup Introduction](#setup-introduction)
- [1. Kubernetes](#1-kubernetes)
- [1.1. Kubernetes Installation with Docker](#11-kubernetes-installation-with-docker)
- [2. Continue with Deployment](#2-continue-with-deployment)

## 1. Kubernetes

This section will guide the reader through the deployment process to setup Kubernetes within Docker.
Expand Down Expand Up @@ -66,4 +67,6 @@ This section will guide the reader through the deployment process to setup Kuber
kubectl config use-context docker-desktop
```

3. Continue setup and configuration from the Kubernetes Dashboard section in the [Mojaloop's deployment guide - 3.2. Kubernetes Admin Interfaces](./README.md#32-kubernetes-admin-interfaces) document.
## 2. Continue with Deployment

1. Continue setup and configuration from the [Mojaloop's deployment guide - 3.1. Kubernetes Ingress Controller](#31-kubernetes-ingress-controller) document.
11 changes: 3 additions & 8 deletions deployment-guide/local-setup-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ At this point the reader/implementer should be familiar with [Mojaloop's deploym
- [1. Kubernetes](#1-kubernetes)
- [1.1 Kubernetes Installation with Docker](#11-kubernetes-installation-with-docker)
- [1.2 Kubernetes environment setup](#12-kubernetes-environment-setup)
- [2. Continue with Deployment](#2-continue-with-deployment)

## 1. Kubernetes

Expand Down Expand Up @@ -109,12 +110,6 @@ This section will guide the reader through the deployment process to setup Kuber

![Docker For Desktop](./assets/diagrams/deployment/DockerForDesktop.png)

3. Install an Ingress Controller
## 2. Continue with Deployment

Install nginx-ingress for load balancing & external access:

```bash
helm --namespace kube-public install stable/nginx-ingress
```

4. Continue setup and configuration from the Kubernetes Dashboard section in the [Mojaloop's deployment guide - 3.2. Kubernetes Admin Interfaces](./README.md#32-kubernetes-admin-interfaces) document.
1. Continue setup and configuration from the [Mojaloop's deployment guide - 3.1. Kubernetes Ingress Controller](#31-kubernetes-ingress-controller) document.
12 changes: 4 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "documentation",
"version": "11.3.2",
"version": "11.4.2",
"description": "Mojaloop Documentation GitBook Project",
"dependencies": {
"express": "4.17.1",
Expand Down