Skip to content

Commit

Permalink
docs: update readme to follow 1.9 updates (#460)
Browse files Browse the repository at this point in the history
Signed-off-by: João Vanzuita <[email protected]>

Signed-off-by: João Vanzuita <[email protected]>
  • Loading branch information
João Paulo Vanzuita authored Sep 30, 2022
1 parent 7939de4 commit 064dc23
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@

# Kubefirst CLI

The Kubefirst CLI is a cloud provisioning tool. With simple setup and two CLI commands, we create a kubernetes cluster managed with automated Infrastructure as Code, GitOps asset management and application delivery, secrets management, a sample application delivered to development, staging, and production, and so much more. It's an open source platform ready to be customized to suit your company's needs.
The Kubefirst CLI is a cloud provisioning tool. With simple setup and two CLI commands, we create a kubernetes cluster
managed with automated Infrastructure as Code, GitOps asset management and application delivery, secrets management, a
sample application delivered to development, staging, and production, and so much more. It's an open source platform
ready to be customized to suit your company's needs.

- [DNS Setup](#dns-setup)
- [Installing the CLI](#installing-the-cli)
Expand Down Expand Up @@ -70,7 +73,10 @@ brew install kubefirst/tools/kubefirst

## Initialization

Some process requires previous initialization, for that, run:
Since Kubefirst 1.9 version, GitHub is also available as a Git platform provider alongside GitLab.

### GitLab
To prepare the installation using GitLab you can:

```bash
kubefirst init \
Expand All @@ -82,6 +88,24 @@ kubefirst init \
--hosted-zone-name domain.example
```

### GitHub

To prepare the installation using GitHub you can:

```bash
kubefirst init \
--admin-email [email protected] \
--cloud aws \
--hosted-zone-name example.com \
--region eu-central-1 \
--cluster-name example_com \
--profile default \
--github-user example-github-username \
--github-org example-organization \
--gitops-branch main \
--metaphor-branch main
```

## Creation

At this point, everything is ready to start provisioning the cloud services, and for that run:
Expand Down Expand Up @@ -119,8 +143,6 @@ Kubefirst provides extra tooling for handling the provisioning work.

| Command | Description |
|:---------------|:----------------------------------------------------------|
| argocdSync | Request ArgoCD to synchronize applications |
| checktools | use to check compatibility of .kubefirst/tools |
| clean | removes all kubefirst resources locally for new execution |
| cluster create | create a kubefirst management cluster |
| destroy | destroy the kubefirst management cluster |
Expand Down

0 comments on commit 064dc23

Please sign in to comment.