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.

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

updated deployment guides to be more specific with kuberentes & helm versions #265

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 9 additions & 4 deletions deployment-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,20 @@ The document is intended for an audience with a stable technical knowledge that
Versions numbers below are hard requirements, not just recommendations (more recent versions are known not to work).

A list of the pre-requisite tool set required for the deployment of Mojaloop:
- **Kubernetes 1.15.x** An open-source system for automating deployment, scaling, and management of containerized applications. Find out more about [Kubernetes](https://kubernetes.io),
- kubectl - Kubernetes CLI for Kubernetes Management is required. Find out more about [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/),
- **Kubernetes** An open-source system for automating deployment, scaling, and management of containerized applications. Find out more about [Kubernetes](https://kubernetes.io),
<br>_Recommended Versions:_
<br>&nbsp;&nbsp;&nbsp;&nbsp;_**Mojaloop Helm Chart release v11.x** supports **Kuberentes v1.13 - v1.17**, newer versions have not been tested._
<br>&nbsp;&nbsp;&nbsp;&nbsp;_**Mojaloop Helm Chart release v10.x** supports **Kuberentes v1.13 - v1.15**, it will fail on Kuberentes v1.16+ onwards due deprecated APIs ([ref: Helm Issue #219](https://github.com/mojaloop/helm/issues/219))._
- kubectl - Kubernetes CLI for Kubernetes Management is required. Find out more about [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/):
- [Install-kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/),
- microk8s - MicroK8s installs a barebones upstream Kubernetes for a single node deployment generally used for local development. We recommend this installation on Linux (ubuntu) OS. Find out more about [microk8s](https://microk8s.io/) and [microk8s documents](https://microk8s.io/docs/),
- microk8s - MicroK8s installs a barebones upstream Kubernetes for a single node deployment generally used for local development. We recommend this installation on Linux (ubuntu) OS. Find out more about [microk8s](https://microk8s.io/) and [microk8s documents](https://microk8s.io/docs/):
- [Install-microk8s](https://microk8s.io/docs/),
- kubectx - Not required but useful. Find out more about [kubectx](https://github.com/ahmetb/kubectx),
- kubetail - Not required but useful. Bash script that enables you to aggregate (tail/follow) logs from multiple pods into one stream. Find out more about [kubetail](https://github.com/johanhaleby/kubetail),
- **Docker** Provides containerized environment to host the application. Find out more about [Docker](https://docker.com),
- **Helm v2.x** A package manager for Kubernetes. Find out more about [Helm](https://helm.sh),
- **Helm** A package manager for Kubernetes. Find out more about [Helm](https://helm.sh),
<br>_Recommended Versions:_
<br>&nbsp;&nbsp;&nbsp;&nbsp;_**Helm v3.x** ([ref: Design Auth Issue #52](https://github.com/mojaloop/design-authority/issues/52))._
- **Postman** Postman is a Google Chrome application for the interacting with HTTP API's. It presents you with a friendly GUI for the construction requests and reading responces. https://www.getpostman.com/apps. Find out more about [Postman](https://postman.com).

For **local guides** on how to setup the pre-requisites on your laptop or desktop, refer to the appropriate link document below;
Expand Down
5 changes: 5 additions & 0 deletions deployment-guide/local-setup-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ Don't have the snap command? [Install snapd first](https://snapcraft.io/docs/cor
```bash
snap install microk8s --classic
```

Specific version:
```bash
snap install microk8s --classic --channel=1.16/stable
```

2. Verify MicroK8s is installed and available.
```bash
Expand Down
Loading