Skip to content

Commit 2cfc984

Browse files
committed
UD-1829: Update documentation to include the oauth authorization process
Signed-off-by: Kevin Conner <[email protected]>
1 parent 7212ad3 commit 2cfc984

File tree

4 files changed

+43
-20
lines changed

4 files changed

+43
-20
lines changed
131 KB
Loading
89.7 KB
Loading

docs/dashboard.md

+42-19
Original file line numberDiff line numberDiff line change
@@ -15,42 +15,65 @@ across all your clusters. You can also invite users to your workspace.
1515
<a href="https://zora-dashboard.undistro.io/" class="md-button">Try Zora Dashboard</a>
1616
</div>
1717

18-
Currently, it's free for up to 3 clusters.
19-
Please [contact us](https://undistro.io/contact){:target="_blank"} if you need unlock more clusters in Zora Dashboard.
18+
Zora Dashboard offers a ***starter plan for 14 days***, after which it will revert to the free plan which provides access for 2 clusters with up to 10 nodes per cluster.
19+
Please [contact us](https://undistro.io/contact){:target="_blank"} if you need to discuss a tailored solution.
2020

2121
## Getting started
2222

23-
To integrate your cluster with Zora Dashboard, you need to provide the workspace ID
24-
as an additional parameter in Zora OSS installation command.
23+
To integrate your Zora OSS installation with Zora Dashboard, you need to first authenticate with the authorization server and then provide your `saas.workspaceID` parameter in the Zora OSS installation command.
2524

26-
1. Sign in at [Zora Dashboard](https://zora-dashboard.undistro.io){:target="_blank"};
27-
2. Click on "Connect cluster" button and copy the workspace ID;
28-
3. Then provide it in `saas.workspaceID` parameter in [Zora OSS installation command](getting-started/installation.md):
25+
### Authenticating with the Authorization server
26+
Authenticating with the authorization server is simplified through the use of a helm plugin, `zoraauth`, which can be installed by executing
27+
28+
```console
29+
helm plugin install https://github.com/undistro/helm-zoraauth
30+
```
31+
and updated by executing
32+
```console
33+
helm plugin update zoraauth
34+
```
35+
The authentication process will occur when the plugin is executed, and you visit the authorization server to confirm the request. The instructions within the Zora Dashboard console will include the appropriate parameters for the plugin, these can be obtained through the `Connect cluster` option once you have signed in to the Zora Dashboard.
36+
37+
To authenticate with the authorization server, copy and run the `helm zoraauth` command and then follow the instructions within your terminal
38+
```console
39+
helm zoraauth --audience="zora_prod" \
40+
--client-id="<client id>" \
41+
--domain="login.undistro.io"
42+
Initiating Device Authorization Flow...
43+
Please visit https://login.undistro.io/activate and enter code: BFNS-NWFF, or visit: https://login.undistro.io/activate?user_code=BFNS-NWFF
44+
```
45+
Entering the login URL within your browser will present you with a screen similar to the following
46+
47+
<img src="assets/zora-device-confirmation.png" width="409" height="465"/>
48+
49+
Once you have confirmed the request you should see the following message on your terminal
50+
51+
```console
52+
Tokens saved to tokens.yaml
53+
```
54+
55+
You can then install Zora OSS by providing the `saas.workspaceID` parameter in the [Zora OSS installation command](getting-started/installation.md):
2956

3057
=== "HTTP chart repository"
3158

32-
```shell hl_lines="9"
59+
```shell hl_lines="7"
3360
helm repo add undistro https://charts.undistro.io --force-update
3461
helm repo update undistro
3562
helm upgrade --install zora undistro/zora \
36-
-n zora-system \
37-
--version 0.10.0 \
38-
--create-namespace \
39-
--wait \
63+
-n zora-system --create-namespace --wait \
4064
--set clusterName="$(kubectl config current-context)" \
41-
--set saas.workspaceID=<YOUR WORKSPACE ID HERE>
65+
--set saas.workspaceID=<YOUR WORKSPACE ID HERE> \
66+
--values tokens.yaml
4267
```
4368

4469
=== "OCI registry"
4570

46-
```shell hl_lines="7"
71+
```shell hl_lines="5"
4772
helm upgrade --install zora oci://ghcr.io/undistro/helm-charts/zora \
48-
-n zora-system \
49-
--version 0.10.0 \
50-
--create-namespace \
51-
--wait \
73+
-n zora-system --create-namespace --wait \
5274
--set clusterName="$(kubectl config current-context)" \
53-
--set saas.workspaceID=<YOUR WORKSPACE ID HERE>
75+
--set saas.workspaceID=<YOUR WORKSPACE ID HERE> \
76+
--values tokens.yaml
5477
```
5578

5679

docs/getting-started/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Then, run the following command to install Zora [Helm chart](https://helm.sh/doc
5151
This command will install Zora in `zora-system` namespace, creating the namespace if it doesn't already exist.
5252

5353
!!! info "Zora OSS + Zora Dashboard"
54-
To integrate your Zora OSS installation with Zora Dashboard, you need to provide `saas.workspaceID` parameter in installation command.
54+
To integrate your Zora OSS installation with Zora Dashboard, you need to authenticate with the authorization server and provide `saas.workspaceID` parameter in installation command.
5555
For more information, please refer to [this page](../dashboard.md#getting-started).
5656

5757
With the following commands, you can verify if Zora has been successfully installed and retrieve installation notes:

0 commit comments

Comments
 (0)