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

Adds guide to install the toolkit #273

Merged
merged 2 commits into from
Aug 25, 2022
Merged

Adds guide to install the toolkit #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
831008b
Adds guide to install the toolkit
seansund Aug 25, 2022
4e1c2cd
Merge branch 'main' into tz-automation
seansund Aug 25, 2022
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
2 changes: 1 addition & 1 deletion docs/developer-intermediate/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The learning tasks help you understand the Developer Experience with IBM RedHat
| [Inventory BFF](inventory-bff/) | Creating the Inventory BFF with GraphQL | | 25 mins | |
| [Inventory UI](inventory-ui/) | Creating the UI microservice | | 25 mins | |
| [Inventory Backend with Cloudant](../developer-advanced-1/database-with-cloudant/)| Cloudant Database integration | | 30 mins | |

| [Install the toolkit](../guides/toolkit-install/)| Install the Cloud-Native Toolkit in your cluster | | 30 mins | |

!!! success

Expand Down
55 changes: 55 additions & 0 deletions docs/guides/toolkit-install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Cloud-Native Toolkit installation
---

The Cloud-Native Toolkit is available as a simple installation on top of an OpenShift cluster.

### 1. Provision the infrastructure

There are several options for getting the infrastructure

#### TechZone infrastructure

IBM TechZone provides infrastructure for education or demonstration purposes.
Several managed environments are available. For IBM Cloud OpenShift, use this
collection: https://techzone.ibm.com/collection/roks-basics-lab#tab-1

#### Provisioned infrastructure

The Cloud-Native Toolkit provides automation solutions to provision
infrastructure on IBM Cloud, AWS, or Azure. Each option requires a cloud account
with necessary permissions in order to run. Follow the instructions in the
repository to provision the environment.

- https://github.com/IBM/automation-ibmcloud-infra-openshift
- https://github.com/IBM/automation-azure-infra-openshift
- https://github.com/IBM/automation-aws-infra-openshift

#### Bring your own cluster

If you have an existing cluster that was provisioned manually or through some other means, you can use it to install the Toolkit. Make sure you have the server url and the credentials for a user that has sufficient permissions to create namespaces and RBAC rules in the cluster.

### 2. Install the Toolkit into the cluster

To install the toolkit perform the following steps:

1. In a command or terminal window ensure you are logged onto your cluster (oc login or kubectl login) with an admin account with the ability to create new namespaces/projects on the cluster and setup RBAC security.

2. Run the following command (choose your operating system):

**For Linux / MacOS**

```
curl -sfL get.cloudnativetoolkit.dev | sh -
```

**For Windows**

```
oc create -f https://raw.githubusercontent.com/cloud-native-toolkit/ibm-garage-iteration-zero/master/install/install-ibm-toolkit.yaml
sleep 5
oc wait pod -l job-name=ibm-toolkit --for=condition=Ready -n default
oc logs job/ibm-toolkit -f -n default
```

3. Wait for the automation scripts to complete the installation of the toolkit - this can take several minutes