You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by GitBox <gi...@apache.org> on 2022/04/12 09:56:13 UTC

[GitHub] [incubator-inlong] shink opened a new pull request, #3646: [INLONG-3489] Improve documentation in helm chart

shink opened a new pull request, #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646

   Fixes: #3489
   
   ### Motivation
   
   - provide some useful information in [NOTES.txt](docker/kubernetes/templates/NOTES.txt)
   - provide more detailed comments in [values.yaml](docker/kubernetes/values.yaml) to help users configure it
   
   ### Modifications
   
   The [NOTES.txt](docker/kubernetes/templates/NOTES.txt) content will be printed when installing the chart.
   
   ![image](https://user-images.githubusercontent.com/49934421/162933559-41e5483b-e730-4678-a1e0-d8a23f81f101.png)
   
   ### Verifying this change
   
   *(Please pick either of the following options)*
   
   - [x] This change is a trivial rework/code cleanup without any test coverage.
   
   - [ ] This change is already covered by existing tests, such as:
     *(please describe tests)*
   
   - [ ] This change added tests and can be verified as follows:
   
     *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] dockerzhang commented on pull request #3646: [INLONG-3489][K8s] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
dockerzhang commented on PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#issuecomment-1096582963

   @shink please update the document on the [office website](https://inlong.apache.org/docs/next/deployment/k8s).
   you can refer to https://github.com/apache/incubator-inlong-website/pull/342
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] shink commented on a diff in pull request #3646: [INLONG-3489] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
shink commented on code in PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#discussion_r848241793


##########
docker/kubernetes/README.md:
##########
@@ -1,21 +1,65 @@
-## The Helm Chart for Apache InLong
+# The Helm Chart for Apache InLong
 
-### Prerequisites
+## Prerequisites
 
 - Kubernetes 1.10+
 - Helm 3.0+
 - A dynamic provisioner for the PersistentVolumes(`production environment`)
 
-### Usage
+## Usage
 
-#### Install
+### Install
+
+If the namespace named `inlong` does not exist, create it first by running:
 
 ```shell
 kubectl create namespace inlong
+```
+
+To install the chart with a namespace named `inlong`, try:
+
+```shell
 helm upgrade inlong --install -n inlong ./
 ```
 
-#### Configuration
+### Access InLong Dashboard
+
+If `ingress.enabled` in [values.yaml](values.yaml) is set to `true`, you just access `http://${ingress.host}/dashboard` in browser.
+
+Otherwise, when `dashboard.service.type` is set to `ClusterIP`, you need to execute the port-forward command like:
+
+```shell
+export DASHBOARD_POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=inlong-dashboard,app.kubernetes.io/instance=inlong" -o jsonpath="{.items[0].metadata.name}" -n inlong)
+export DASHBOARD_CONTAINER_PORT=$(kubectl get pod $DASHBOARD_POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}" -n inlong)
+kubectl port-forward $DASHBOARD_POD_NAME 8181:$DASHBOARD_CONTAINER_PORT -n inlong
+```
+
+And then access [http://127.0.0.1:8181](http://127.0.0.1:8181)
+
+> Tip: If the error of `unable to do port forwarding: socat not found` appears, you need to install `socat` at first.
+
+Or when `dashboard.service.type` is set to `NodePort`, you need to execute the following commands:
+
+```shell
+export DASHBOARD_NODE_IP=$(kubectl get nodes -o jsonpath="{.items[0].status.addresses[0].address}" -n inlong)
+export DASHBOARD_NODE_PORT=$(kubectl get svc inlong-dashboard -o jsonpath="{.spec.ports[0].nodePort}" -n inlong)
+```
+
+And then access `http://$DASHBOARD_NODE_IP:$DASHBOARD_NODE_PORT`
+
+When `dashboard.service.type` is set to `LoadBalancer`, you need to execute the following command:
+
+```shell
+export DASHBOARD_SERVICE_IP=$(kubectl get svc inlong-dashboard --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}"  -n inlong)
+```
+
+And then access `http://$DASHBOARD_SERVICE_IP:30080`
+
+> NOTE: It may take a few minutes for the `LoadBalancer` IP to be available. You can check the status by running `kubectl get svc inlong-dashboard -n inlong -w`
+
+The default username and password are `inlong`. You can access the InLong Dashboard through them.

Review Comment:
   @dockerzhang Are the default username and password right?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] shink commented on a diff in pull request #3646: [INLONG-3489] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
shink commented on code in PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#discussion_r848241793


##########
docker/kubernetes/README.md:
##########
@@ -1,21 +1,65 @@
-## The Helm Chart for Apache InLong
+# The Helm Chart for Apache InLong
 
-### Prerequisites
+## Prerequisites
 
 - Kubernetes 1.10+
 - Helm 3.0+
 - A dynamic provisioner for the PersistentVolumes(`production environment`)
 
-### Usage
+## Usage
 
-#### Install
+### Install
+
+If the namespace named `inlong` does not exist, create it first by running:
 
 ```shell
 kubectl create namespace inlong
+```
+
+To install the chart with a namespace named `inlong`, try:
+
+```shell
 helm upgrade inlong --install -n inlong ./
 ```
 
-#### Configuration
+### Access InLong Dashboard
+
+If `ingress.enabled` in [values.yaml](values.yaml) is set to `true`, you just access `http://${ingress.host}/dashboard` in browser.
+
+Otherwise, when `dashboard.service.type` is set to `ClusterIP`, you need to execute the port-forward command like:
+
+```shell
+export DASHBOARD_POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=inlong-dashboard,app.kubernetes.io/instance=inlong" -o jsonpath="{.items[0].metadata.name}" -n inlong)
+export DASHBOARD_CONTAINER_PORT=$(kubectl get pod $DASHBOARD_POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}" -n inlong)
+kubectl port-forward $DASHBOARD_POD_NAME 8181:$DASHBOARD_CONTAINER_PORT -n inlong
+```
+
+And then access [http://127.0.0.1:8181](http://127.0.0.1:8181)
+
+> Tip: If the error of `unable to do port forwarding: socat not found` appears, you need to install `socat` at first.
+
+Or when `dashboard.service.type` is set to `NodePort`, you need to execute the following commands:
+
+```shell
+export DASHBOARD_NODE_IP=$(kubectl get nodes -o jsonpath="{.items[0].status.addresses[0].address}" -n inlong)
+export DASHBOARD_NODE_PORT=$(kubectl get svc inlong-dashboard -o jsonpath="{.spec.ports[0].nodePort}" -n inlong)
+```
+
+And then access `http://$DASHBOARD_NODE_IP:$DASHBOARD_NODE_PORT`
+
+When `dashboard.service.type` is set to `LoadBalancer`, you need to execute the following command:
+
+```shell
+export DASHBOARD_SERVICE_IP=$(kubectl get svc inlong-dashboard --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}"  -n inlong)
+```
+
+And then access `http://$DASHBOARD_SERVICE_IP:30080`
+
+> NOTE: It may take a few minutes for the `LoadBalancer` IP to be available. You can check the status by running `kubectl get svc inlong-dashboard -n inlong -w`
+
+The default username and password are `inlong`. You can access the InLong Dashboard through them.

Review Comment:
   @dockerzhang Are the default username password right?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] dockerzhang merged pull request #3646: [INLONG-3489][K8s] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
dockerzhang merged PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] shink commented on pull request #3646: [INLONG-3489][K8S] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
shink commented on PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#issuecomment-1096626129

   @dockerzhang OK.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] shink commented on a diff in pull request #3646: [INLONG-3489][K8S] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
shink commented on code in PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#discussion_r848344337


##########
docker/kubernetes/README.md:
##########
@@ -1,21 +1,65 @@
-## The Helm Chart for Apache InLong
+# The Helm Chart for Apache InLong
 
-### Prerequisites
+## Prerequisites
 
 - Kubernetes 1.10+
 - Helm 3.0+
 - A dynamic provisioner for the PersistentVolumes(`production environment`)
 
-### Usage
+## Usage
 
-#### Install
+### Install
+
+If the namespace named `inlong` does not exist, create it first by running:
 
 ```shell
 kubectl create namespace inlong
+```
+
+To install the chart with a namespace named `inlong`, try:
+
+```shell
 helm upgrade inlong --install -n inlong ./
 ```
 
-#### Configuration
+### Access InLong Dashboard
+
+If `ingress.enabled` in [values.yaml](values.yaml) is set to `true`, you just access `http://${ingress.host}/dashboard` in browser.
+
+Otherwise, when `dashboard.service.type` is set to `ClusterIP`, you need to execute the port-forward command like:
+
+```shell
+export DASHBOARD_POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=inlong-dashboard,app.kubernetes.io/instance=inlong" -o jsonpath="{.items[0].metadata.name}" -n inlong)
+export DASHBOARD_CONTAINER_PORT=$(kubectl get pod $DASHBOARD_POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}" -n inlong)
+kubectl port-forward $DASHBOARD_POD_NAME 8181:$DASHBOARD_CONTAINER_PORT -n inlong
+```
+
+And then access [http://127.0.0.1:8181](http://127.0.0.1:8181)
+
+> Tip: If the error of `unable to do port forwarding: socat not found` appears, you need to install `socat` at first.
+
+Or when `dashboard.service.type` is set to `NodePort`, you need to execute the following commands:
+
+```shell
+export DASHBOARD_NODE_IP=$(kubectl get nodes -o jsonpath="{.items[0].status.addresses[0].address}" -n inlong)
+export DASHBOARD_NODE_PORT=$(kubectl get svc inlong-dashboard -o jsonpath="{.spec.ports[0].nodePort}" -n inlong)
+```
+
+And then access `http://$DASHBOARD_NODE_IP:$DASHBOARD_NODE_PORT`
+
+When `dashboard.service.type` is set to `LoadBalancer`, you need to execute the following command:
+
+```shell
+export DASHBOARD_SERVICE_IP=$(kubectl get svc inlong-dashboard --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}"  -n inlong)
+```
+
+And then access `http://$DASHBOARD_SERVICE_IP:30080`
+
+> NOTE: It may take a few minutes for the `LoadBalancer` IP to be available. You can check the status by running `kubectl get svc inlong-dashboard -n inlong -w`
+
+The default username and password are `inlong`. You can access the InLong Dashboard through them.

Review Comment:
   Done.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] shink commented on a diff in pull request #3646: [INLONG-3489] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
shink commented on code in PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#discussion_r848243755


##########
docker/kubernetes/values.yaml:
##########
@@ -602,14 +632,15 @@ tubemqBroker:
       -XX:MaxRAMPercentage=80.0
       -XX:-UseAdaptiveSizePolicy
 
-# InLong will use the external Services.
+# If exists external MySQL or Pulsar, you can set the 'enable' field value to true and configure related information.
 external:
   mysql:
     enabled: false
     hostname: "localhost"
     port: 3306
     username: "root"
     password: "password"
+  # If there is no external Pulsar, InLong will use TubeMQ.
   pulsar:
     enabled: false
     serviceUrl: "localhost:6650"

Review Comment:
   @dockerzhang Is it right?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] dockerzhang commented on a diff in pull request #3646: [INLONG-3489][K8s] Improve documentation in helm chart

Posted by GitBox <gi...@apache.org>.
dockerzhang commented on code in PR #3646:
URL: https://github.com/apache/incubator-inlong/pull/3646#discussion_r848305204


##########
docker/kubernetes/README.md:
##########
@@ -1,21 +1,65 @@
-## The Helm Chart for Apache InLong
+# The Helm Chart for Apache InLong
 
-### Prerequisites
+## Prerequisites
 
 - Kubernetes 1.10+
 - Helm 3.0+
 - A dynamic provisioner for the PersistentVolumes(`production environment`)
 
-### Usage
+## Usage
 
-#### Install
+### Install
+
+If the namespace named `inlong` does not exist, create it first by running:
 
 ```shell
 kubectl create namespace inlong
+```
+
+To install the chart with a namespace named `inlong`, try:
+
+```shell
 helm upgrade inlong --install -n inlong ./
 ```
 
-#### Configuration
+### Access InLong Dashboard
+
+If `ingress.enabled` in [values.yaml](values.yaml) is set to `true`, you just access `http://${ingress.host}/dashboard` in browser.
+
+Otherwise, when `dashboard.service.type` is set to `ClusterIP`, you need to execute the port-forward command like:
+
+```shell
+export DASHBOARD_POD_NAME=$(kubectl get pods -l "app.kubernetes.io/name=inlong-dashboard,app.kubernetes.io/instance=inlong" -o jsonpath="{.items[0].metadata.name}" -n inlong)
+export DASHBOARD_CONTAINER_PORT=$(kubectl get pod $DASHBOARD_POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}" -n inlong)
+kubectl port-forward $DASHBOARD_POD_NAME 8181:$DASHBOARD_CONTAINER_PORT -n inlong
+```
+
+And then access [http://127.0.0.1:8181](http://127.0.0.1:8181)
+
+> Tip: If the error of `unable to do port forwarding: socat not found` appears, you need to install `socat` at first.
+
+Or when `dashboard.service.type` is set to `NodePort`, you need to execute the following commands:
+
+```shell
+export DASHBOARD_NODE_IP=$(kubectl get nodes -o jsonpath="{.items[0].status.addresses[0].address}" -n inlong)
+export DASHBOARD_NODE_PORT=$(kubectl get svc inlong-dashboard -o jsonpath="{.spec.ports[0].nodePort}" -n inlong)
+```
+
+And then access `http://$DASHBOARD_NODE_IP:$DASHBOARD_NODE_PORT`
+
+When `dashboard.service.type` is set to `LoadBalancer`, you need to execute the following command:
+
+```shell
+export DASHBOARD_SERVICE_IP=$(kubectl get svc inlong-dashboard --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}"  -n inlong)
+```
+
+And then access `http://$DASHBOARD_SERVICE_IP:30080`
+
+> NOTE: It may take a few minutes for the `LoadBalancer` IP to be available. You can check the status by running `kubectl get svc inlong-dashboard -n inlong -w`
+
+The default username and password are `inlong`. You can access the InLong Dashboard through them.

Review Comment:
   `admin`
   `inlong`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org