Skip to content

Commit 4095a05

Browse files
committed
Update self-hosted ZenML Pro deployment docs
1 parent 2b98605 commit 4095a05

File tree

9 files changed

+11
-12
lines changed

9 files changed

+11
-12
lines changed
435 KB
Loading
33.6 KB
Loading
19.3 KB
Loading
-6.41 KB
Loading
11.7 KB
Loading
37.4 KB
Loading
-54.8 KB
Loading
-7.81 KB
Loading

docs/book/getting-started/zenml-pro/self-hosted.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -807,12 +807,12 @@ However, this feature is currently supported with helper Python scripts, as desc
807807
```bash
808808
kubectl get secret --namespace zenml-pro zenml-pro -o jsonpath="{.data.ZENML_CLOUD_ADMIN_PASSWORD}" | base64 --decode; echo
809809
```
810-
2. Create a `users.yml` file that contains a list of all the users that you want to create for ZenML. Also set a default password. The users will be asked to change this password on their first login.
810+
2. Create a `users.yaml` file that contains a list of all the users that you want to create for ZenML. Also set a default password. The users will be asked to change this password on their first login.
811811

812812
```yaml
813813
users:
814-
- username: [email protected]
815-
password: tu3]4_Xz{5$9
814+
- username: user
815+
password: password1234
816816
```
817817
3. Run the `create_users.py` script below. This will create all of the users.
818818

@@ -853,7 +853,7 @@ However, this feature is currently supported with helper Python scripts, as desc
853853
response = requests.post(login_url, headers=headers, data=data)
854854
855855
if response.status_code == 200:
856-
return response.json().get("token")
856+
return response.json().get("access_token")
857857
else:
858858
print(f"Login failed. Status code: {response.status_code}")
859859
print(f"Response: {response.text}")
@@ -916,7 +916,7 @@ However, this feature is currently supported with helper Python scripts, as desc
916916
main()
917917
```
918918
919-
The script will prompt you for the URL of your deployment, the admin account username and password and finally the location of your `users.yml` file.
919+
The script will prompt you for the URL of your deployment, the admin account username and password and finally the location of your `users.yaml` file.
920920
921921
![](.gitbook/assets/on-prem-01.png)
922922
@@ -944,15 +944,13 @@ Now you can invite your whole team to the org. For this open the drop-down in th
944944
945945
![](.gitbook/assets/on-prem-05.png)
946946
947-
Here in the members tab, add all the users you created in the previous step.
947+
Here in the members tab, add all the users you created in the previous step. Make sure to [assign the appropriate role](roles.md#organization-level-roles) to each user.
948948
949949
![](.gitbook/assets/on-prem-06.png)
950950
951-
For each user, finally head over to the Pending invited screen and copy the invite link for each user.
952-
953951
![](.gitbook/assets/on-prem-07.png)
954952
955-
Finally, send the invitation link, along with the account's username and initial password over to your team members.
953+
Finally, send the account's username and initial password over to your team members.
956954
957955
## Stage 2/2: Enroll and Deploy ZenML Pro workspaces
958956
@@ -1469,20 +1467,21 @@ If you use TLS certificates for the ZenML Pro control plane or workspace server
14691467
14701468
#### Accessing the Workspace Dashboard
14711469
1472-
The newly enrolled workspace should be accessible in the ZenML Pro workspace dashboard and the CLI now. You need to login as an organization member and add yourself as a workspace member first):
1470+
The newly enrolled workspace should be accessible in the ZenML Pro workspace dashboard and the CLI now. If you're the organization admin, you may also need to add other users as workspace members, if they don't have access to the workspace yet.
14731471
14741472
![](.gitbook/assets/on-prem-08.png)
14751473
14761474
![](.gitbook/assets/on-prem-09.png)
14771475
14781476
![](.gitbook/assets/on-prem-10.png)
14791477
1480-
Then follow the instructions in the checklist to unlock the full dashboard:
1481-
14821478
![](.gitbook/assets/on-prem-11.png)
14831479
1480+
Then follow the instructions in the "Get Started" checklist to unlock the full dashboard:
1481+
14841482
![](.gitbook/assets/on-prem-12.png)
14851483
1484+
14861485
#### Accessing the Workspace from the ZenML CLI
14871486
14881487
To login to the workspace with the ZenML CLI, you need to pass the custom ZenML Pro API URL to the `zenml login` command:

0 commit comments

Comments
 (0)