Merge pull request #17 from renyunkang/master

doc: update readme

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,37 +4,18 @@ about: Create a report to help us improve
 labels: kind/bug
 ---
 
-
-**General remarks**
-
-> This form is to report bugs. For general usage questions refer to our Slack channel
-> [KubeSphere-users](https://join.slack.com/t/kubesphere/shared_invite/zt-1ilxbsp39-t4ES4xn5OI0eF5hvOoAhEw)
-
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 For UI issues please also add a screenshot that shows the issue.
 
 **Versions used(KubeSphere/Kubernetes)**
-KubeSphere:
-Kubernetes: (If KubeSphere installer used, you can skip this)
-
-
-**Environment**
-How many nodes and their hardware configuration: 
-
-For example:
-3 masters: 8cpu/8g
-3 nodes: 8cpu/16g
-
-(and other info are welcomed to help us debugging)
+KubeSphere: (If KubeSphere isn't used, you can skip this)
+Kubernetes: 
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,4 @@
-<!-- Thanks for sending a pull request! Here are some tips for you:
-
-1. If you want **faster** PR reviews, read how: https://github.com/kubesphere/community/blob/master/developer-guide/development/the-pr-author-guide-to-getting-through-code-review.md
-2. In case you want to know how your PR got reviewed, read: https://github.com/kubesphere/community/blob/master/developer-guide/development/code-review-guide.md
-3. Here are some coding convetions followed by KubeSphere community: https://github.com/kubesphere/community/blob/master/developer-guide/development/coding-conventions.md
--->
+<!-- Thanks for sending a pull request! -->
 
 ### What type of PR is this?
 <!-- 
@@ -13,13 +8,7 @@ Add one of the following kinds:
 /kind documentation
 /kind feature
 /kind design
-
-Optionally add one or more of the following kinds if applicable:
-/kind api-change
-/kind deprecation
-/kind failing-test
-/kind flake
-/kind regression
+...
 -->
 
 
@@ -28,35 +17,10 @@ Optionally add one or more of the following kinds if applicable:
 ### Which issue(s) this PR fixes:
 <!--
 Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-_If PR is about `failing-tests or flakes`, please post the related issues/tests in a comment and do not use `Fixes`_*
 -->
 Fixes #
 
 ### Special notes for reviewers:
 ```
-```
-
-### Does this PR introduced a user-facing change?
-<!--
-If no, just write "None" in the release-note block below.
-If yes, a release note is required:
-Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required".
-
-For more information on release notes see: https://github.com/kubernetes/community/blob/master/contributors/guide/release-notes.md
--->
-```release-note
-
-```
-
-### Additional documentation, usage docs, etc.:
-<!--
-This section can be blank if this pull request does not require a release note.
-Please use the following format for linking documentation or pass the
-section below:
-- [KEP]: <link>
-- [Usage]: <link>
-- [Other doc]: <link>
--->
-```docs
 
 ```

README.md

@@ -26,9 +26,10 @@ The minimum version required is 1.22.19, but you can use a newer version.
 #### [Optional] Docker
 
 This is optional. If you just want to test and build on your local environment, there is no need to install docker. Otherwise, you need to install it.
-[Install on Mac](https://docs.docker.com/desktop/mac/install/)
-[Install on Windows](https://docs.docker.com/desktop/windows/install/)
-[Install on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
+
+- [Install on Mac](https://docs.docker.com/desktop/mac/install/)
+- [Install on Windows](https://docs.docker.com/desktop/windows/install/)
+- [Install on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
 
 #### [Optional] Make
 
@@ -43,16 +44,35 @@ git clone https://github.com/openelb/console.git
 cd console/
 yarn
 ```
+* Make sure there is openelb-manager service of type nodeport in your cluster, if not create it:
+```yaml
+kind: Service
+apiVersion: v1
+metadata:
+ name: openelb-manager
+ namespace: openelb-system
+ labels:
+ app: openelb-manager
+spec:
+ ports:
+ - name: server
+ protocol: TCP
+ port: 80
+ targetPort: 8080
+ nodePort: 30871
+ selector:
+ app: openelb-manager
+ type: NodePort
+```
+* Add openelb-manager service address into this function([createURL](https://github.com/openelb/console/blob/ea00c35e70b492990379bfebc41b27174265a083/src/utils/request.js#L98)) as follows:
 
-* and then, add openelb-manage service address into this function([createURL](https://github.com/openelb/console/blob/ea00c35e70b492990379bfebc41b27174265a083/src/utils/request.js#L98)) as follows:
-
- > the default port of openelb-manage service in k8s is `30000` .
+ > the default port of openelb-manager service in k8s is `30871` .
 
 ```
-return `http://${your service machine ip}:${openelb-manage service address}:${port}/${path.trimLeft('/')}`
+return `http://${your service machine ip}:${openelb-manager service address}:${port}/${path.trimLeft('/')}`
 ```
 
-* next, run command:
+* Run command:
 
 ```
 yarn start
@@ -62,7 +82,7 @@ yarn start
 >
 > `yarn config set registry https://registry.npmmirror.com`
 
-* now, you can debug it in chrome browser.
+now, you can debug it in chrome browser.
 
 ## How to build
 
@@ -74,9 +94,9 @@ Just run the following command with your real `REPO` address.
 REPO=yourawesomerepo make container
 ```
 
-### run in docker
+### Run in docker
 
-1. Modify `server.domain:port` in `build/default.conf` to the actual deployment address of openelb console.
+1. Modify `server.domain:port` in `deploy/default.conf` to the actual deployment address of openelb console.
 2. Mount the configuration file into the docker container
 3. Expose container port 8088
 
@@ -86,7 +106,7 @@ docker run --rm -d --name=openelb-console -v ${PWD}/deploy/default.conf:/etc/ngi
 
 You can access openelb-console using ${hostIP}:8088. *(hostIP is the ip of the node where the command is run)*
 
-### run in kubernetes
+### Run in kubernetes
 
 Check whether the pod and service port information correspond to each other *(You may have modified the port listened by openelb-manager during installation)*. If there is no problem, install it into kubernetes using kubectl.
 
@@ -96,7 +116,7 @@ Use the service of nodeport type to expose the openelb-console service. Port 308
 kubectl apply -f deploy/console.yaml
 ```
 
-### get the frontend bundle file
+### Get the frontend bundle file
 
 If you want to get the frontend file in local machine, you can run:
 

deploy/console.yaml

@@ -46,10 +46,10 @@ metadata:
  app: openelb-manager
 spec:
  ports:
- - name: web
+ - name: server
  protocol: TCP
  port: 80
- targetPort: 30000
+ targetPort: 8080
  selector:
  app: openelb-manager
  type: ClusterIP