- More than one command is mentioned in the single code block
- Here is the documentation link [1]:
[1] https://docs.openshift.com/container-platform/4.18/observability/logging/logging-6.0/log6x-clf.html#legacy-service-accounts
- As per the standard rule, using more than one command per code block is not recommended.
- Please check Standard rule [2] for reference:
[2] https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#single-command-per-code-block
- When commands are bunched together, the copy to clipboard functionality might not break the lines up correctly. Using a single command per code block makes it copy-and-paste friendly.
- Hence we need to mention 2 separate code blocks for above 2 commands.
- Here is the updated look of the documentation:
~~~
$ oc adm policy add-cluster-role-to-user collect-application-logs system:serviceaccount:openshift-logging:logcollector
~~~
~~~
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs system:serviceaccount:openshift-logging:logcollector
~~~
- Incorrect configuration under scaling redundancy for the log visualizer nodes documentation
- Here is the documentation link:
https://docs.openshift.com/container-platform/4.16/observability/logging/log_visualization/logging-kibana.html#cluster-logging-kibana-scaling_logging-kibana
=============
- namespace name is missing from the command.
- same command is mentioned twice in the second block. Which is not required and hence needs to be removed.
- "namespace: openshift-logging" field is missing under `metadata` section.
- 2 extra spaces under `spec.visulization`, it will not cause any effect. But it needs to be with correct indentation.
===========
===========
Reason:
1. Suppose the user is not a part of openshift-logging project, and he tries to run this command then this command will not work.
2. If the credentials are shared, and two people are using the same cluster at the same time, then, the second person could change to work in a different namespace.
===============
Updated documentation will look like the following:
1. Edit the ClusterLogging custom resource (CR) in the openshift-logging project:
~~~
$ oc -n openshift-logging edit ClusterLogging instance
~~~
~~~
apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
name: "instance"
namespace: openshift-logging
....
spec:
visualization:
type: "kibana"
kibana:
replicas: 1
~~~
renaming new assembly
moving file from troubleshooting to architecture folder
resolved xref issue
resolved hcp fie issue
changed from assembly to module to appear in the raci doc
add content in id of module
removing assembly in OSD topic map and renaming as managed and not sd-managed
adding a condition in the node-cluster-overcommit assembly line113 for osd
adding a new anchor in the node-cluster-overcommit assembly line113
conditionalising an assembly
fixed topic maps to sd
fixed assembly to gp to the anchor mocule or matrix assembly
updating the content for sdmanaged doc
removed : from csdmanaged resources doc
removing landing page
applied peer review suggestion
removed space
- Need to remove additional nodeSelector and tolerations from Lokistack CR
- Here is the documentation link:
https://docs.openshift.com/container-platform/4.14/observability/logging/logging-6.0/log6x-loki.html#logging-loki-pod-placement_logging-6x:~:text=Example%20LokiStack%20CR%20with%20node%20selectors%20and%20tolerations
- nodeSelector and tolerations are mentioned twice under the distributor field of Lokistack CR.
~~~
distributor:
nodeSelector:
node-role.kubernetes.io/infra: ""
tolerations:
- effect: NoSchedule
key: node-role.kubernetes.io/infra
value: reserved
- effect: NoExecute
key: node-role.kubernetes.io/infra
value: reserved
nodeSelector:
node-role.kubernetes.io/infra: ""
tolerations:
- effect: NoSchedule
key: node-role.kubernetes.io/infra
value: reserved
- effect: NoExecute
key: node-role.kubernetes.io/infra
value: reserved
~~~
- values for both nodeSelector and tolerations are the same.
- Keeping it twice is not required and it is an unnecessary configuration.
- Hence need to remove additional nodeSelector and tolerations from the documentation.
- Here is the updated look:
~~~
distributor:
nodeSelector:
node-role.kubernetes.io/infra: ""
tolerations:
- effect: NoSchedule
key: node-role.kubernetes.io/infra
value: reserved
- effect: NoExecute
key: node-role.kubernetes.io/infra
value: reserved
~~~
