Skip to content

Commit f04f11b

Browse files
committed
docs: update README.md [skip ci]
1 parent 3e54bd3 commit f04f11b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can either build binary from source, or just download pre-built binary.
3030
## Usage
3131

3232
1. Ensure `kubectl` and `helm` are available in `$PATH`
33-
2. Prepare a **manifests directory**, see below
33+
2. Prepare a **resource directory**, see below
3434
3. Run `ezdeploy`
3535

3636
## Options
@@ -39,10 +39,10 @@ You can either build binary from source, or just download pre-built binary.
3939
- `--kubeconfig` or `KUBECONFIG`, specify path to `kubeconfig` file
4040
- `KUBECONFIG_BASE64`, base64 encoded `kubeconfig` file content
4141

42-
## Layout of Manifests Directory
42+
## Layout of a Resource Directory
4343

4444
- Each top-level directory stands for a **namespace**
45-
- Every manifest file in that directory, will be applied to that **namespace**
45+
- Every resource file in that directory, will be applied to that **namespace**
4646

4747
For example:
4848

@@ -78,7 +78,7 @@ kube-system/
7878
`ezdeploy` will create or update a **release** named `main`, using **chart** `_helm/ingress-nginx`, and **values file**
7979
`kube-system/primary.ingress-nginx.helm.yaml`
8080

81-
`ezdeploy` also support values file in `jsonnet`
81+
`ezdeploy` also support values file in `jsonnet`, file name should be `[RELEASE_NAME].[CHART_NAME].helm.jsonnet`
8282

8383
## Credits
8484

0 commit comments

Comments
 (0)