This is an automated email from the ASF dual-hosted git repository.
zhouquan 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 fc7e722 SUBMARINE-319. kind-cluster-build.sh doesn't invoke installed
kind
fc7e722 is described below
commit fc7e722da84fe6a7f0a195ed6f080fdd410b1931
Author: Zac Zhou <[email protected]>
AuthorDate: Thu Dec 12 17:30:05 2019 +0800
SUBMARINE-319. kind-cluster-build.sh doesn't invoke installed kind
### What is this PR for?
kind-cluster-build.sh can download kind automatically. But
kind-cluster-build.sh doesn't use it. kind-cluster-build.sh invoke kind command
which is defined in PATH variable.
We need to let users to move downloaded kind and kubectl to system path
locations. So that users can directly use kind and kubectl to interact with
the local k8s cluster.
### What type of PR is it?
Improvement
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-319
### How should this be tested?
https://travis-ci.org/yuanzac/hadoop-submarine/builds/624064493?utm_source=github_status&utm_medium=notification
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Yes
Author: Zac Zhou <[email protected]>
Closes #127 from yuanzac/topic/SUBMARINE-319 and squashes the following
commits:
4519d4d [Zac Zhou] SUBMARINE-319. kind-cluster-build.sh doesn't invoke
installed kind
---
submarine-cloud/hack/kind-cluster-build.sh | 19 ++++++----
submarine-cloud/submarine-operator.md | 61 ++++++++++++++++--------------
2 files changed, 45 insertions(+), 35 deletions(-)
diff --git a/submarine-cloud/hack/kind-cluster-build.sh
b/submarine-cloud/hack/kind-cluster-build.sh
index 67a557a..5e01fed 100755
--- a/submarine-cloud/hack/kind-cluster-build.sh
+++ b/submarine-cloud/hack/kind-cluster-build.sh
@@ -22,9 +22,6 @@ cd $ROOT
source $ROOT/hack/lib.sh
-hack::ensure_kubectl
-hack::ensure_kind
-
usage() {
cat <<EOF
This script use kind to create Kubernetes cluster, about kind please refer:
https://kind.sigs.k8s.io/
@@ -89,13 +86,21 @@ echo "k8sVersion: ${k8sVersion}"
echo "volumeNum: ${volumeNum}"
# check requirements
-for requirement in kind docker
+for requirement in kind docker kubectl
do
echo "############ check ${requirement} ##############"
if hash ${requirement} 2>/dev/null;then
echo "${requirement} have installed"
else
echo "this script needs ${requirement}, please install ${requirement}
first."
+ if test ${requirement} = "kind"; then
+ hack::ensure_kind
+ echo "Please add $KIND_BIN to PATH variable or copy it to one of
the locations $PATH"
+ fi
+ if test ${requirement} = "kubectl"; then
+ hack::ensure_kubectl
+ echo "Please add $KUBECTL_BIN to PATH variable or copy it to one
of the locations $PATH"
+ fi
exit 1
fi
done
@@ -148,7 +153,7 @@ export KUBECONFIG="$(kind get kubeconfig-path
--name=${clusterName})"
echo "deploy docker registry in kind"
registryNode=${clusterName}-control-plane
-registryNodeIP=$($KUBECTL_BIN get nodes ${registryNode} -o template
--template='{{range.status.addresses}}{{if eq .type
"InternalIP"}}{{.address}}{{end}}{{end}}')
+registryNodeIP=$(kubectl get nodes ${registryNode} -o template
--template='{{range.status.addresses}}{{if eq .type
"InternalIP"}}{{.address}}{{end}}{{end}}')
registryFile=${workDir}/registry.yaml
cat <<EOF >${registryFile}
@@ -219,10 +224,10 @@ spec:
- tcp-listen:5000,fork,reuseaddr
- tcp-connect:${registryNodeIP}:5000
EOF
-$KUBECTL_BIN apply -f ${registryFile}
+kubectl apply -f ${registryFile}
echo "init submarine env"
-$KUBECTL_BIN create ns submarine-e2e
+kubectl create ns submarine-e2e
echo "############# success create cluster:[${clusterName}] #############"
diff --git a/submarine-cloud/submarine-operator.md
b/submarine-cloud/submarine-operator.md
index a785222..a2e72be 100644
--- a/submarine-cloud/submarine-operator.md
+++ b/submarine-cloud/submarine-operator.md
@@ -1,30 +1,41 @@
-# Submarine Operator Development Instructions
+# Submarine Operator Instructions
-See also official sample：https://github.com/kubernetes/sample-controller
+## Build submarine operator
-# Implementation steps
+### Prerequisite
-## 1. Submit the CRD template and its instantiation object to the k8s cluster,
so that k8s can recognize
+1 Golang environment is required.
+
+2 Submarine project should be in the path of ${GOPATH}/src/github.com/apache/.
+Alternatively, we can create a soft link named submarine, pointing to submarine
+repo, under the path of ${GOPATH}/src/github.com/apache/.
+
+### Build submarine operator binary
+```
+cd ${GOPATH}/src/github.com/apache/submarine/submarine-cloud
+make build
```
-1 Official document CRD
-https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
-2 Log in to a machine that can execute kubectl commands and create a
student.yaml file
-[root@localhost student]# kubectl apply -f student.yaml
-customresourcedefinition.apiextensions.k8s.io/students.stable.k8s.io created
-[root@localhost student]# kubectl get crd
-NAME CREATED AT
-crontabs.stable.example.com 2019-03-26T01:48:32Z
-students.stable.k8s.io 2019-04-12T02:42:08Z
+## Run submarine operator locally
-3 Use the template student.yaml to instantiate a Student object, create
test1.yaml, and similarly test2.yaml
-[root@localhost student]# kubectl apply -f test1.yaml
-student.stable.k8s.io/test1 created
+Start a kind cluster
-4 kubectl describe std test1
+```
+cd ${GOPATH}/src/github.com/apache/submarine/submarine-cloud/hack
+./kind-cluster-build.sh --name "submarine"
```
-## 2. Preparation before automatic code generation
+Run submarine operator
+```
+# create submarine crd
+kubectl apply -f ../manifests/crd.yaml
+KUBECONFIG=$(kind get kubeconfig-path --name submarine)
+./submarine-operator run config=${KUBECONFIG}
+```
+
+## Submarine operator implementation steps
+
+### Preparation before automatic code generation
1 Create a new directory under the samplecontroller directory and add the
following files
@@ -48,7 +59,7 @@ go get -u k8s.io/code-generator/...
go get -u k8s.io/apiextensions-apiserver/...
```
-## 3. Automatically generate Client, Informer, WorkQueue related code
+### Automatically generate Client, Informer, WorkQueue related code
```
[root@localhost launcher-k8s]# export GOPATH=/root/mygolang
[root@localhost launcher-k8s]# ./hack/update-codegen.sh
@@ -107,11 +118,11 @@ pkg
│ └── student.go
```
-## 4. Write controller business logic
+### Write controller business logic
Refer to the sample-controller project, it is relatively simple to write
-## 5. Startup controller
+### Startup controller
```
[root@localhost samplecontroller]# ./samplecontroller
// This is a simple custom k8s controller,
@@ -141,16 +152,10 @@ ERROR: logging before flag.Parse: I0415 15:02:28.719547
109337 samplecontroller
```
-## 6. Modify the crd instance file to observe the controller
+### Modify the crd instance file to observe the controller
```
........
kubectl apply -f test1.yaml
kubectl describe std test1
```
-## Development
-1. go mod download
-Dependency packages will be automatically downloaded to `$GOPATH/pkg/mod`.
Multiple projects can share cached mods.
-
-2. go mod vendor
-Copy from the mod to the vendor directory of your project so the IDE can
recognize it!
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
