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

correction to github install consistent with 1.10.8 #810

Merged
merged 1 commit into from
Dec 1, 2022
Merged

correction to github install consistent with 1.10.8 #810

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
35 changes: 4 additions & 31 deletions docs/kubefirst/github/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,49 +76,22 @@ With your new KUBEFIRST_GITHUB_AUTH_TOKEN exported, let's init your local setup
export KUBEFIRST_GITHUB_AUTH_TOKEN=your-new-token

kubefirst init \
--admin-email your_name@yourcompany.com \
--admin-email yourname@yourcompany.com \
--cloud aws \
--hosted-zone-name yourdomain.com \
--region us-east-1 \
--profile default \
--cluster-name your_cluster_name \
--s3-suffix you-s3-bucket-name \
--github-user yourgithubhandle \
--github-owner yourgithuborganization
```

#### Using a config file

```yaml
# config.yaml
config:
admin-email: your_name@yourcompany.com
cloud: aws
hosted-zone-name: yourdomain.com
region: us-east-1
profile: default
cluster-name: your_cluster_name
s3-suffix: you-s3-bucket-name
github-user: yourgithubhandle
github-owner: yourgithuborganization
```

```bash
export KUBEFIRST_GITHUB_AUTH_TOKEN=your-new-token

kubefirst init -c config.yaml
--cluster-name your-cluster-name \
--github-user your-bot-users-github-username \
--github-owner your-github-organization-name
```

The `init` process produces a directory of utilities, a state file, and some staged platform content that can now be found at `~/.kubefirst`

<!-- TODO: check final state file name above - state file collides with directory -->

### Step 3 - `kubefirst cluster create`

Now it's time to create the platform, to do so, simply run

```
kubefirst cluster create
```

<!-- TODO: check final state command above - talk through stack vs cluster with team -->