[submarine] branch master updated: SUBMARINE-936. Add README to submarine-cloud-v2/artifacts/examples

[ka...@apache.org]

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 37f70df  SUBMARINE-936. Add README to submarine-cloud-v2/artifacts/examples
37f70df is described below

commit 37f70df6ae185103fc7c7309ed1e2e44b6d0c7d4
Author: noidname01 <ti...@gmail.com>
AuthorDate: Tue Jul 13 20:57:38 2021 +0800

    SUBMARINE-936. Add README to submarine-cloud-v2/artifacts/examples
    
    ### What is this PR for?
    Add README to submarine-cloud-v2/artifacts/examples to explain the meaning of each file.
    
    ### What type of PR is it?
    [ Documentation ]
    
    ### Todos
    
    ### What is the Jira issue?
    
    https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-936
    
    ### 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: noidname01 <ti...@gmail.com>
    
    Signed-off-by: Kai-Hsun Chen <ka...@apache.org>
    
    Closes #675 from noidname01/SUBMARINE-936 and squashes the following commits:
    
    8280c795 [noidname01] add README for operator-example
---
 submarine-cloud-v2/artifacts/examples/README.md | 32 +++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/submarine-cloud-v2/artifacts/examples/README.md b/submarine-cloud-v2/artifacts/examples/README.md
new file mode 100644
index 0000000..e92c0ff
--- /dev/null
+++ b/submarine-cloud-v2/artifacts/examples/README.md
@@ -0,0 +1,32 @@
+<!---
+  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.
+-->
+
+`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.
+
+
+
+
+

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org