add docs about enable kubectl logs feature #1914

YaozhongZhang · 2020-07-09T08:13:19Z

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind test
/kind failing-test
/kind feature

/kind documentation

What this PR does / why we need it:
restore docs about how to enable kubectl logs feature which is been deleted by mistake before

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

kadisi · 2020-07-09T08:16:27Z

docs/setup/keadm.md

@@ -95,6 +95,48 @@ Host has mosquit+ already installed and running. Hence skipping the installation
 KubeEdge edgecore is running, For logs visit:  /var/log/kubeedge/edgecore.log
 ```

+### Enable `kubectl logs` Feature


logs and metric feature ?

@fisherxu PTAL

@kadisi ,metric may need wait for a new release of metric-server. Otherwise user need to make a choice between kubelet or edgecore.

daixiang0 · 2020-07-09T08:39:48Z

docs/setup/keadm.md

+  ```bash
+  wget https://raw.githubusercontent.com/kubeedge/kubeedge/master/build/tools/certgen.sh 
+  chmod +x certgen.sh
+  ./certgen.sh stream


Where set this?

if [ -z ${CLOUDCOREIPS} ]; then echo "You must set CLOUDCOREIPS Env,The environment variable is set to specify the IP addresses of all cloudcore" echo "If there are more than one IP need to be separated with space." exit 1 fi

daixiang0 · 2020-07-09T08:40:34Z

docs/setup/keadm.md

+ Set `CLOUDCOREIP` env. The environment variable is set to specify the IP address of cloudcore, or a VIP if you have a highly available cluster.
+
+  ```bash
+  export CLOUDCOREIP="172.20.12.45"


Please do not use your ip for safety, 192.168.0.1 is enough.

daixiang0 · 2020-07-09T08:41:52Z

docs/setup/keadm.md

+  ** Note: ** You need to set the cloudcoreip variable first
+
+  ```bash
+  iptables -t nat -A OUTPUT -p tcp --dport 10350 -j DNAT --to $CLOUDCOREIP:10003


10350 and 10003 is default value, need to comment which value they point.

@daixiang0 Done. PTAL.

fisherxu · 2020-07-16T07:22:47Z

@YaozhongZhang Is it possible to enable logs feature in hack/local-up-kubeedge script?

YaozhongZhang · 2020-07-16T07:40:59Z

@YaozhongZhang Is it possible to enable logs feature in hack/local-up-kubeedge script?

@fisherxu I can try it. Shoud I open another PR?

fisherxu · 2020-07-16T11:30:22Z

@fisherxu I can try it. Shoud I open another PR?

Sure, another PR is fine

daixiang0 · 2020-07-17T00:36:56Z

docs/setup/keadm.md

@@ -95,6 +95,49 @@ Host has mosquit+ already installed and running. Hence skipping the installation
 KubeEdge edgecore is running, For logs visit:  /var/log/kubeedge/edgecore.log
 ```

+### Enable `kubectl logs` Feature
+ First , you need to make sure you can find the kubernetes `ca.crt` and `ca.key` files. If you set up your kubernetes cluster by `kubeadm` , those files will be in `/etc/kubernetes/pki/` dir.


Better to write in this format:

1. make sure ... 2. set env ... ...

@daixiang0 Done. PTAL.

fisherxu · 2020-08-07T09:14:54Z

docs/setup/keadm.md

@@ -95,6 +95,49 @@ Host has mosquit+ already installed and running. Hence skipping the installation
 KubeEdge edgecore is running, For logs visit:  /var/log/kubeedge/edgecore.log
 ```

+### Enable `kubectl logs` Feature
+1. Make sure you can find the kubernetes `ca.crt` and `ca.key` files. If you set up your kubernetes cluster by `kubeadm` , those files will be in `/etc/kubernetes/pki/` dir.


What are the ca.crt and ca.key used for here? @YaozhongZhang

@fisherxu They are used to sign the certificates used by CloudStream.

fisherxu · 2020-08-07T12:27:13Z

/lgtm
/approve

kubeedge-bot · 2020-08-07T12:27:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fisherxu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [fisherxu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kubeedge-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 9, 2020

kubeedge-bot requested review from edisonxiang and rohitsardesai83 July 9, 2020 08:13

kubeedge-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 9, 2020

kadisi reviewed Jul 9, 2020

View reviewed changes

daixiang0 reviewed Jul 9, 2020

View reviewed changes

YaozhongZhang force-pushed the log-feature-doc-fix branch from 4111db4 to d147159 Compare July 9, 2020 09:26

GsssC mentioned this pull request Jul 13, 2020

Kubectl logs failed #1876

Closed

YaozhongZhang force-pushed the log-feature-doc-fix branch 2 times, most recently from 1f0fe1a to 5c43213 Compare July 16, 2020 07:18

daixiang0 reviewed Jul 17, 2020

View reviewed changes

YaozhongZhang force-pushed the log-feature-doc-fix branch from 5c43213 to 99dffb7 Compare July 17, 2020 04:06

add docs of enable kubectl logs feature

65923e5

YaozhongZhang force-pushed the log-feature-doc-fix branch from 99dffb7 to 65923e5 Compare July 17, 2020 10:55

daixiang0 mentioned this pull request Aug 7, 2020

Add metrics-server docs #2049

Merged

fisherxu reviewed Aug 7, 2020

View reviewed changes

kubeedge-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 7, 2020

kubeedge-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 7, 2020

kubeedge-bot merged commit 39b02f9 into kubeedge:master Aug 7, 2020

YaozhongZhang deleted the log-feature-doc-fix branch August 10, 2020 07:06

YaozhongZhang mentioned this pull request Aug 24, 2020

REQUEST: New membership for YaozhongZhang kubeedge/community#18

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add docs about enable kubectl logs feature #1914

add docs about enable kubectl logs feature #1914

YaozhongZhang commented Jul 9, 2020

kadisi Jul 9, 2020

GsssC Jul 12, 2020

daixiang0 Jul 9, 2020

daixiang0 Jul 9, 2020 •

edited

Loading

daixiang0 Jul 9, 2020

YaozhongZhang Jul 9, 2020

fisherxu commented Jul 16, 2020

YaozhongZhang commented Jul 16, 2020 •

edited

Loading

fisherxu commented Jul 16, 2020

daixiang0 Jul 17, 2020 •

edited

Loading

YaozhongZhang Jul 17, 2020

fisherxu Aug 7, 2020

YaozhongZhang Aug 7, 2020

fisherxu Aug 7, 2020

fisherxu commented Aug 7, 2020

kubeedge-bot commented Aug 7, 2020

add docs about enable kubectl logs feature #1914

add docs about enable kubectl logs feature #1914

Conversation

YaozhongZhang commented Jul 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daixiang0 Jul 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fisherxu commented Jul 16, 2020

YaozhongZhang commented Jul 16, 2020 • edited Loading

fisherxu commented Jul 16, 2020

daixiang0 Jul 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fisherxu commented Aug 7, 2020

kubeedge-bot commented Aug 7, 2020

daixiang0 Jul 9, 2020 •

edited

Loading

YaozhongZhang commented Jul 16, 2020 •

edited

Loading

daixiang0 Jul 17, 2020 •

edited

Loading