This is an automated email from the ASF dual-hosted git repository.
kaihsun 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 5a4e2e5 SUBMARINE-934. Add README to submarine-cloud-v2/hack
5a4e2e5 is described below
commit 5a4e2e5171298678728d035f76d1547d88a112a0
Author: Kenchu123 <[email protected]>
AuthorDate: Tue Jul 13 17:47:37 2021 +0800
SUBMARINE-934. Add README to submarine-cloud-v2/hack
### What is this PR for?
<!-- A few sentences describing the overall goals of the pull request's
commits.
First time? Check out the contributing guide -
https://submarine.apache.org/contribution/contributions.html
-->
Add README to submarine-cloud-v2/hack to explain how to use the scripts.
### What type of PR is it?
[Documentation]
### Todos
None
### What is the Jira issue?
<!-- * Open an issue on Jira
https://issues.apache.org/jira/browse/SUBMARINE/
* Put link here, and add [SUBMARINE-*Jira number*] in PR title, eg.
`SUBMARINE-23. PR title`
-->
https://issues.apache.org/jira/browse/SUBMARINE-934
### How should this be tested?
<!--
* First time? Setup Travis CI as described on
https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed
behavior
* Outline any manual steps to test the PR here.
-->
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: Kenchu123 <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Closes #669 from Kenchu123/SUBMARINE-934 and squashes the following commits:
af08b589 [Kenchu123] SUBMARINE-934. Update hack README
a103be03 [Kenchu123] SUBMARINE-934. change namespace in hack/build_image.sh
07c0b449 [Kenchu123] SUBMARINE-934. Add README to hack scripts
---
submarine-cloud-v2/hack/README.md | 71 ++++++++++++++++++++++++++++++++++
submarine-cloud-v2/hack/build_image.sh | 2 +-
2 files changed, 72 insertions(+), 1 deletion(-)
diff --git a/submarine-cloud-v2/hack/README.md
b/submarine-cloud-v2/hack/README.md
new file mode 100644
index 0000000..e5b41e9
--- /dev/null
+++ b/submarine-cloud-v2/hack/README.md
@@ -0,0 +1,71 @@
+<!---
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. See accompanying LICENSE file.
+-->
+
+`update-codegen.sh`
+
+This script will use the generators in
[k8s.io/code-generator](https://github.com/kubernetes/code-generator) to
generate a typed client, informers, listers and deep-copy functions.
+
+The codes will be generated at
`github.com/apache/submarine/submarine-cloud-v2/pkg/client/`.
+
+```bash
+# You should be under the folder `submarine-cloud-v2`
+./hack/update-codegen.sh
+```
+
+`verify-codegen.sh`
+
+This script will verify whether your codes are outdated. If your codes are
outdated, please regenerate using `update-codegen.sh`.
+
+```bash
+# You should be under the folder `submarine-cloud-v2`
+./hack/verify-codegen.sh
+```
+
+`build-image.sh`
+
+This script is to make developing with submarine-operator more convenient. It
will rebuild the image and recreate the deployment, and one can see the result
of changes.
+
+```bash
+# You should be under the folder `submarine-cloud-v2`
+./hack/build_image.sh <image>
+
+image:
+ all build all images
+ server build submarine server
+ database build submarine database
+ jupyter build submarine jupyter-notebook
+ jupyter-gpu build submarine jupyter-notebook-gpu
+ mlflow build submarine mlflow
+```
+
+`server-rapid-builder.sh`
+
+This script is to make the building process of submarine-server faster.
+
+```bash
+# You should be under the folder `submarine-cloud-v2/hack`
+./server-rapid-builder.sh [namespace]
+```
+
+`run_frontend_e2e.sh`
+
+This script is to run frontend end-to-end test.
+
+```bash
+# The workbench should run on port 8080
+kubectl port-forward --address 0.0.0.0 -n submarine-user-test service/traefik
8080:80
+
+./hack/run_frontend_e2e.sh
+```
+
diff --git a/submarine-cloud-v2/hack/build_image.sh
b/submarine-cloud-v2/hack/build_image.sh
index e427e95..6ff5f12 100755
--- a/submarine-cloud-v2/hack/build_image.sh
+++ b/submarine-cloud-v2/hack/build_image.sh
@@ -18,7 +18,7 @@
#
set -e
-NAMESPACE="submarine-operator-test"
+NAMESPACE="submarine-user-test"
# ========================================
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
