This is an automated email from the ASF dual-hosted git repository.
kuanhsun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new accdf4a SUBMARINE-1111. Add description of creating yaml files for
custom resources.
accdf4a is described below
commit accdf4a011198bef29a1cb1698b40b562559797d
Author: 傅譽的MacBook <[email protected]>
AuthorDate: Fri Dec 10 02:16:18 2021 +0800
SUBMARINE-1111. Add description of creating yaml files for custom resources.
…ource.
### What is this PR for?
Update developer-guide.md in submarine cloud v2.
The update includes notifications of not using helm and other tips.
### What type of PR is it?
Improvement
### Todos
None
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-1111
### How should this be tested?
None
### Screenshots (if appropriate)
None
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: 傅譽的MacBook <[email protected]>
Signed-off-by: kuanhsun <[email protected]>
Closes #821 from FYRichie/SUBMARINE-1111 and squashes the following commits:
c17d0729 [傅譽的MacBook] SUBMARINE-1111. Add description of creating yaml
files for custom resource.
50f09b31 [傅譽的MacBook] SUBMARINE-1111. Add description of creating yaml
files for custom resource.
---
submarine-cloud-v2/docs/developer-guide.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/submarine-cloud-v2/docs/developer-guide.md
b/submarine-cloud-v2/docs/developer-guide.md
index 96755c6..9367771 100644
--- a/submarine-cloud-v2/docs/developer-guide.md
+++ b/submarine-cloud-v2/docs/developer-guide.md
@@ -31,6 +31,14 @@ We use
[code-generator](https://github.com/kubernetes/code-generator) to generat
Everytime when you change the codes in `submarine-cloud-v2/pkg/apis`, you must
run `make api` to re-generate the API.
+## Create New Custom Resources
+
+To modify the parameters of submarine resource, go to the location
`submarine/submarine-cloud-v2/artifacts` to edit specific `yaml` files. In this
case, you won't need to modify the code for operator.
+
+However, if you intend to create a new custom resource, you should also add a
corresponding operator code in `submarine/submarine-cloud-v2/pkg/controller`.
+
+**Important**: Your `yaml` files should `NOT` include `helm` grammer.
+
## Add New Dependencies
```bash
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
