You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/book/src/getting-started.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ kconnect help
12
12
13
13
The general workflow for using kconnect is the following:
14
14
15
-
-`kconnect configure` - import configuration that contains defaults for your origanisation - **1 time**
15
+
-`kconnect configure` - import configuration that contains defaults for your organisation - **1 time**
16
16
-`kconnect use` - connect to a cluster for the first time - **only the first time**
17
17
-`kconnect to` - use to reconnect to a cluster that you have already connected to - **most used command day-to-day**
18
18
19
19
## Creating and importing configuration
20
20
21
-
Before using `kconnect` to connect to a Kubernetes cluster you may want to import an idetitiy provider configuration with your (or your organisations) defaults so that you don't have to supply all connection settings each time you connect to a new cluster.
21
+
Before using `kconnect` to connect to a Kubernetes cluster you may want to import an identity provider configuration with your (or your organisations) defaults so that you don't have to supply all connection settings each time you connect to a new cluster.
22
22
23
23
You will need to create a configuration file (see example [here](https://github.com/fidelity/kconnect/blob/main/examples/config.yaml)). The configuration file can be imported from a local file or remote location via HTTP/HTTPS (and from stdin).
24
24
@@ -64,4 +64,4 @@ kconnect to 01EM615GB2YX3C6WZ9MCWBDWBF
64
64
65
65
Flags can be replaced with environment variables by following the format `UPPERCASED_SNAKE_CASE` and appending to the `KCONNECT_` prefix.
66
66
67
-
For example`--username`can be set as`KCONNECT_USERNAME`; or `--idp-protocol` as`KCONNECT_IDP_PROTOCOL`.
67
+
For example`--username`can be set as`KCONNECT_USERNAME`; or `--idp-protocol` as`KCONNECT_IDP_PROTOCOL`.
10. Take the output of this command (excluding logging output). Update this file https://github.com/fidelity/krew-index/blob/main/plugins/connect.yaml with the output you just obtainted (note: these manual steps will be automated in future)
33
+
10. Take the output of this command (excluding logging output). Update this file https://github.com/fidelity/krew-index/blob/main/plugins/connect.yaml with the output you just obtained (note: these manual steps will be automated in future)
34
34
35
35
## Implementation
36
36
37
37
We use [goreleaser](https://goreleaser.com/) to do the majority of the build, packaging and release. The [.goreleaser.yml](https://github.com/fidelity/kconnect/blob/main/.goreleaser.yml) configuration file drives this.
38
38
39
39
The **goreleaser** GitHub Action that kicks off goreleaser on tagging the main branch is located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release.yml).
40
40
41
-
There is an additional GitHub workflow thats used to publish the docs to GitHub pages and that's located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release-docs.yml).
41
+
There is an additional GitHub workflow that is used to publish the docs to GitHub pages and that is located [here](https://github.com/fidelity/kconnect/blob/main/.github/workflows/release-docs.yml).
0 commit comments