Skip to content

Commit 9c0566f

Browse files
committed
new readme changes
1 parent ca3d253 commit 9c0566f

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

dev/README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,49 +20,50 @@ export CLOUD_STAGING_CLIENT_SECRET="your-client-secret"
2020

2121
### Build Docker images
2222

23+
For all the commands below, you can set `--repo` through an environment variable called `DEV_DOCKER_REPO`.
24+
2325
```bash
2426
# Build a ZenML image
25-
./zen-dev build --repo zenmldocker
27+
./zen-dev build
2628

2729
# Build a ZenML server image
28-
./zen-dev build --server --repo zenmldocker
30+
./zen-dev build --server
2931

30-
# Build with a custom tag
31-
./zen-dev build --repo zenmldocker --tag v1.0
32+
# Build and push the server image
33+
./zen-dev build --server --push
3234

33-
# Build and push
34-
./zen-dev build --repo zenmldocker --push
35+
# Build with a custom tag (tag defaults to the sluggified branch name)
36+
./zen-dev build --repo zenmldocker --tag v1.0
3537
```
3638

37-
`--repo` can also be set as an environment variable as `DEV_DOCKER_REPO`.
38-
`--tag` defaults to the sluggified branch name.
39-
4039
### Deploy a workspace
4140

41+
For all the commands below, you can set `--organization` through an environment variable called `DEV_ORGANIZATION_ID`.
42+
4243
```bash
4344
# Create a new workspace with the latest ZenML version
4445
./zen-dev deploy --organization 0000000-0000-0000-000000
4546

47+
# Create a new workspace with a custom workspace name (workspace defaults to the sluggied branch name)
48+
./zen-dev deploy --workspace custom-name
49+
4650
# Specify custom Docker image and Helm chart version
47-
./zen-dev deploy --workspace my-workspace --zenml-version 0.81.0 --docker-image zenmldocker/zenml-server:custom-tag --helm-version 0.36.0
51+
./zen-dev deploy --zenml-version 0.81.0 --docker-image zenmldocker/zenml-server:custom-tag --helm-version 0.36.0
4852
```
4953

50-
`--organization` can also be set as an environment variable as `DEV_ORGANIZATION_ID`.
51-
`--workspace` defaults to the sluggied branch name.
52-
`--zenml-version` defaults to the verions in the `VERSION` file.
53-
5454
### Update a workspace
5555

5656
```bash
57+
# Update the workspace with the default name (slugified branch name)
58+
./zen-dev update --docker-image some/new:image
59+
5760
# Update an existing workspace with a new ZenML version
5861
./zen-dev update --workspace my-workspace --zenml-version 0.82.0
5962

6063
# Update with a custom Docker image
6164
./zen-dev update --workspace my-workspace --zenml-version 0.82.0 --docker-image zenmldocker/zenml-server:custom-tag
6265
```
6366

64-
`--workspace` defaults to the sluggied branch name.
65-
6667
### Get environment information
6768

6869
```bash
@@ -172,7 +173,7 @@ Other available commands:
172173
To add a new dev pipeline:
173174

174175
1. Create a directory in `dev/pipelines/your_pipeline_name/`
175-
2. Add your pipeline code and a `run.py` file as the entry point
176+
2. Add your pipeline code and a file as the entry point (defaults to run.py)
176177
3. Add the pipeline configuration to `dev/dev_pipelines_config.yaml`
177178
4. Commit and push your changes
178179
5. Trigger the pipeline with a PR comment: `!run your_pipeline_name`

0 commit comments

Comments
 (0)