Skip to content

Commit 21c7220

Browse files
authored
Merge pull request #8 from zenml-io/doc/addmoreinfoonserverurl
Addd docs for workspace URL
2 parents cb51c61 + 220f3c0 commit 21c7220

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,6 @@ terraform {
4444

4545
### Authentication
4646

47-
#### Service Account API Key
48-
4947
Configure the provider with your ZenML server URL and API key:
5048

5149
```hcl
@@ -55,32 +53,42 @@ provider "zenml" {
5553
}
5654
```
5755

56+
For OSS users, the `server_url` is basically the root URL of your ZenML server deployment.
57+
For Pro users, the `server_url` is the the URL of your workspace, which can be found
58+
in your dashboard:
59+
60+
![ZenML workspace URL](assets/workspace_url.png)
61+
62+
It should look like something like `https://1bfe8d94-zenml.cloudinfra.zenml.io`.
63+
64+
#### Option 1: Using `ZENML_API_KEY`
65+
5866
You can also use environment variables:
5967
```bash
6068
export ZENML_SERVER_URL="https://your-zenml-server.com"
6169
export ZENML_API_KEY="your-api-key"
6270
```
6371

64-
To generate a ZENML_API_KEY, follow these steps:
72+
To generate a `ZENML_API_KEY`, follow these steps:
6573

6674
1. Install ZenML:
6775
```bash
6876
pip install zenml
6977
```
7078

71-
2. Connect to your ZenML server:
79+
2. Login to your ZenML server:
7280
```bash
73-
zenml connect --url <API_URL>
81+
zenml login --url <API_URL>
7482
```
7583

7684
3. Create a service account and get the API key:
7785
```bash
7886
zenml service-account create <MYSERVICEACCOUNTNAME>
7987
```
8088

81-
This command will print out the ZENML_API_KEY that you can use with this provider.
89+
This command will print out the `ZENML_API_KEY` that you can use with this provider.
8290

83-
#### API Token
91+
#### Option 1: Using `ZENML_API_TOKEN`
8492

8593
Alternatively, you can use an API token for authentication:
8694

assets/workspace_url.png

1.01 MB
Loading

0 commit comments

Comments
 (0)