Skip to content

doc: add cse config #75

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

Open
muse-sisay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add cse config #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 17 additions & 16 deletions docs/install/colony-prod/install-colony.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

## Step 1 - Installing Colony

The following installation instructions apply to Colony version `v0.2`.
The following installation instructions apply to Colony version `v0.2.2`.

Check failure on line 13 in docs/install/colony-prod/install-colony.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces 

docs/install/colony-prod/install-colony.md:13:74 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md

```bash
git clone https://github.com/konstructio/colony.git
git clone -b cse-config https://github.com/konstructio/colony.git
cd colony
go build .
```
Expand All @@ -28,17 +28,27 @@

## Step 3 - Run the Colony `init`

We introducted 3 additional arugments in the latest version. These arguments are required for CSE install. `gitlab-token` is used to clone and push changes to `autopilot` repository in the new Gitlab instance. `docker-token` is a Github PAT that has permission to GCR and `cse-installer` container image. `api-go-token` is used for creating region in staging (default endpoint).

Check failure on line 31 in docs/install/colony-prod/install-colony.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces 

docs/install/colony-prod/install-colony.md:31:379 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md

```bash
./colony init \
--api-key $YOUR_COLONY_API_KEY \
--load-balancer-interface <asset-managment-interface> \
--load-balancer-ip <ip-address>
--gitlab-token <gitlab-token> \
--api-token <api-go-token> \
--docker-token <github-token> \
```

```bash
export KUBECONFIG=~/.colony/config
```

Then update colony-agent image
```bash
kubectl set image -n tink-system deploy/colony-colony-agent colony-agent=ghcr.io/konstructio/colony-agent:652a30e

Check failure on line 49 in docs/install/colony-prod/install-colony.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces 

docs/install/colony-prod/install-colony.md:49:118 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
```

### Items to Note

- `<interface>` refers to the interface connected to `network boot`.
Expand All @@ -47,26 +57,17 @@

## Step 4 - Asset Discovery

To discover an asset run:

```bash
./colony add-ipmi \
--ip <asset-managment-address> \
--username <username> \
--password <ipmi-password> \
--auto-discover
```

The new asset will appear under the assets tab in the Colony UI.
PXE boot your new servers. The asset will appear under the assets tab in the Colony UI.

## Step 5 - Adding a Cluster

After your Assets are discovered and listed as available you can use them to provision a cluster. You must have a minimum of two Assets to create a cluster (one for the Control plane and one for the Worker node).
After your Assets are discovered and listed as available you can use them to provision a cluster. You must have a minimum of 5 Assets to create a cluster (three for the Control plane and two for the Worker node).

![Create Cluster with Civo](../../img/civostack/initial-configuration.png)

1. Select **Create Cluster** to start this process.
2. Complete Cluster details, Control plane details, and Worker node information as desired.
3. Select **Create CivoStack**** to complete this process.
2. Fill out CSE config
3. Complete Control plane details, and Worker node information as desired.
4. Select **Create CivoStack**** to complete this process.

![Provisioning Clusters](../../img/civostack/provisioning.png)
Loading