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 75ac42f SUBMARINE-940. Improve submarine-cloud-v2 documents
75ac42f is described below
commit 75ac42fc633e174ba2c8b3098ec2ddd7817111f1
Author: Kai-Hsun Chen <[email protected]>
AuthorDate: Thu Jul 15 17:11:47 2021 +0800
SUBMARINE-940. Improve submarine-cloud-v2 documents
### What is this PR for?
Improve submarine-cloud-v2 documents
### What type of PR is it?
[Documentation]
### Todos
* Submarine operator demo videos
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-940
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Closes #681 from kevin85421/SUBMARINE-940 and squashes the following
commits:
ca47b13b [Kai-Hsun Chen] SUBMARINE-940. Improve submarine-cloud-v2 documents
---
submarine-cloud-v2/README.md | 12 +++++-------
submarine-cloud-v2/artifacts/examples/README.md | 22 +++++-----------------
submarine-cloud-v2/docs/developer-guide.md | 12 ++----------
submarine-cloud-v2/hack/README.md | 2 +-
4 files changed, 13 insertions(+), 35 deletions(-)
diff --git a/submarine-cloud-v2/README.md b/submarine-cloud-v2/README.md
index d95f51f..750ac46 100644
--- a/submarine-cloud-v2/README.md
+++ b/submarine-cloud-v2/README.md
@@ -15,13 +15,11 @@
limitations under the License.
-->
-# submarine-cloud-v2
+# submarine-cloud-v2 (submarine operator)
+`submarine-cloud-v2`, i.e. **submarine-operator**, implements the operator for
Submarine application. The operator provides a new option for users to deploy
the Submarine service to their Kubernetes clusters. The **submarine-operator**
can fix some errors automatically. However, if the Submarine service is
deployed with Helm, the errors need to be fixed by human operators.
-`submarine-cloud-v2` implements the operator for Submarine application.
-
-## Why submarine-cloud-v2?
-
-Because `submarine-cloud` is outdated, `submarine-cloud-v2` is the refactored
version of `submarine-cloud`. In addition, after `submarine-cloud-v2` finishes,
we will replace `submarine-cloud` with `submarine-cloud-v2`.
+# Getting Started
+* In this section, we provide two methods, including **out-of-cluter** method
and **in-cluster** method, for you to deploy your **submarine-operator**. In
addition, the out-of-cluster method is convenient for operator developers. On
the other hand, the in-cluster method is suitable for production.
## Initialization
@@ -111,6 +109,6 @@ kubectl delete submarine example-submarine -n
submarine-user-test
kubectl delete deployment submarine-operator-demo
```
-## Development
+# Development
Please check out the [Developer Guide](./docs/developer-guide.md).
diff --git a/submarine-cloud-v2/artifacts/examples/README.md
b/submarine-cloud-v2/artifacts/examples/README.md
index e92c0ff..4f3afa7 100644
--- a/submarine-cloud-v2/artifacts/examples/README.md
+++ b/submarine-cloud-v2/artifacts/examples/README.md
@@ -9,23 +9,11 @@
See the License for the specific language governing permissions and
limitations under the License. See accompanying LICENSE file.
-->
-
-`crd.yaml`
-
-This file defines the schema of our [custom
resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
-
-`example-submarine.yaml`
-
-This file specifies the metadata of our custom resource, we can apply this
file to deploy it.
-
-`submarine-operator-service-account.yaml`
-
-This file grants that submarine-operator has cluster-wide access, which allow
it to operate on other resources.
-
-`submarine-operator.yaml`
-
-We can apply this file to deploy submarine-operator.
-
+# Artifacts
+Before you start reading this document, you need to understand the following
Kubernetes concepts:
+* Custom Resource Definition (CRD)
+* Custom Resource (CR)
+* Role-based access control (RBAC): Cluster Role, Cluster Role Binding, and
Service Account
diff --git a/submarine-cloud-v2/docs/developer-guide.md
b/submarine-cloud-v2/docs/developer-guide.md
index bb8bf16..1fb56d9 100644
--- a/submarine-cloud-v2/docs/developer-guide.md
+++ b/submarine-cloud-v2/docs/developer-guide.md
@@ -25,7 +25,7 @@ For `yaml` files, please use [prettier](https://prettier.io/)
to format the code
## Generate API
-**Important**: You **MUST** put this repository in a folder named
`github.com/apache/`, otherwise the code will be generated into wrong folder.
Therefore the full path of this `developer-guide.md` should be like
`SOMEWHERE_IN_FILESYSTEM/github.com/apache/submarine/submarine-cloud-v2/docs/developer-guide.md`.
+**Important**: You **MUST** put this repository in a folder named
`github.com/apache/`, otherwise, the code will be generated into the wrong
folder. Therefore, the full path of this `developer-guide.md` should be like
`SOMEWHERE_IN_FILESYSTEM/github.com/apache/submarine/submarine-cloud-v2/docs/developer-guide.md`.
We use [code-generator](https://github.com/kubernetes/code-generator) to
generate a typed client, informers, listers and deep-copy functions.
@@ -118,12 +118,4 @@ helmActionConfig := helm.HelmInstall(
// helm uninstall helm-install-example-release
helm.HelmUninstall("helm-install-example-release", helmActionConfig)
-```
-
-- Troubleshooting:
- - If the release name exists, Helm will report the error "cannot re-use a
name that is still in use".
-
-```
-helm ls
-helm uninstall helm-install-example-release
-```
+```
\ No newline at end of file
diff --git a/submarine-cloud-v2/hack/README.md
b/submarine-cloud-v2/hack/README.md
index e5b41e9..fc7c8e7 100644
--- a/submarine-cloud-v2/hack/README.md
+++ b/submarine-cloud-v2/hack/README.md
@@ -14,7 +14,7 @@
`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.
+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/`.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
