-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
93 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,3 +33,5 @@ | |
| html_theme_options = { | ||
| "base_url": "https://madcore.ai/" | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| ============ | ||
| Installation | ||
| ============ | ||
|
|
||
| .. contents:: Table of contents | ||
| :depth: 1 | ||
| :local: | ||
|
|
||
| Madcore lives across 5 Github repositories: https://github.com/madcore-ai All are being actively | ||
| developed across many branches. `development` branch is always kept stable and merged into master | ||
| when features align at which point a Python PIP package is created. This page will explain on how | ||
| to perform a development installation so you have control over branch and commit id's used to pin | ||
| your installation into a known working state. | ||
|
|
||
|
|
||
| Bitbucket Account | ||
| ----------------- | ||
| Bitbucket account must be a member of at least one Bitbucket team. Team name will be used as unique | ||
| name to create your subdomain `https://<bitbucket-team-name>.madcore.cloud` This domain will be | ||
| delegated to your account as part of installation. This is required as Madcore will setup all | ||
| endpoint on HTTPS/SSL protected endpoints. | ||
|
|
||
|
|
||
| AWS Account | ||
| ----------- | ||
| AWS account with access to creating IAM identities and roles. Your instances will assume roles | ||
| and be granted permissions to access your S3 buckets where state is persisted between cluster | ||
| destructions. Not Madcore and Not any other 3rd party has access to your environment. | ||
|
|
||
|
|
||
| Madcore CLI | ||
| ----------- | ||
| CLI must be installed to start the installation. Initial configuration verifies few details | ||
| and then unattended installation takes about 30 minutes to complete the process. At that point | ||
| you will have your master instance (with firewall open only to your ip address). Accessible | ||
| over HTTPS/SSL. You can then securely connect from directly to Jenkins, Grafana and Kubernetes dashboards. | ||
|
|
||
| .. code-block:: bash | ||
| pip install madcore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| ========== | ||
| Technology | ||
| ========== | ||
|
|
||
| .. contents:: Table of contents | ||
| :depth: 1 | ||
| :local: | ||
|
|
||
| Docker Container is the common denominator and this is where your code ends up. | ||
| Docker Registries holds containers. Kubernetes is managing runtime of containers and Kubernetes Charts (Helm) | ||
| are persisting details of infrastructure required to launch your container (scaling, storage, run types, | ||
| variables, secrets). AWS with Ubuntu Xenial infrastructure is used to provide flexible organization of | ||
| Kubernetes layer. Madcore focus is within Kubernetes realm primarily. Cloud and OS | ||
| layer was required since Madcore concept is surrounded by infrastructure elements, however as more cloud providers | ||
| offer Kubernetes-As-Service, we will be able to attach Madcore Project to any of them providing they meet | ||
| project requirements. In what seems an unlimited amount of choices on how to do this we selected one Cloud and | ||
| one OS to stay in focus of mission statement. Below is an incomplete list of credits: | ||
|
|
||
|
|
||
| Containers Selection | ||
| -------------------- | ||
|
|
||
| * Kubernetes containerized by GCE | ||
| * InfluxDB | ||
| * Grafana | ||
| * Lego | ||
|
|
||
|
|
||
| Cloud Technology Selection | ||
| -------------------------- | ||
|
|
||
| * `Amazon Web Services <https://aws.amazon.com>`_ | ||
| * EC2 | ||
| * S3 | ||
| * IAM | ||
| * Cloud Formation | ||
| * Instance Profiles | ||
| * Route53 | ||
|
|
||
|
|
||
| Bare OS Technology Selection | ||
| ---------------------------- | ||
|
|
||
| * Ubuntu Xenial 16.04 | ||
| * Docker and Docker Registry | ||
| * Jenkins | ||
| * Habitat | ||
| * Redis | ||
| * HAProxy | ||
| * Let's Encrypt |