diff --git a/_topic_map.yml b/_topic_map.yml index 10c3bcaa49..9c1281cac8 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -689,18 +689,28 @@ Topics: --- Name: Logging Dir: logging -Distros: openshift-enterprise,openshift-origin +Distros: openshift-enterprise,openshift-origin,openshift-dedicated Topics: - Name: About cluster logging File: efk-logging - Name: About deploying cluster logging File: efk-logging-deploying-about + Distros: openshift-enterprise,openshift-origin - Name: Deploying cluster logging File: efk-logging-deploying + Distros: openshift-enterprise,openshift-origin + Name: Deloying cluster Logging + File: dedicated-efk-deploying + Distros: openshift-dedicated +- Name: Configuring cluster logging + File: dedicated-efk-logging + Distros: openshift-dedicated - Name: Deploying and Configuring the Event Router File: efk-logging-eventrouter + Distros: openshift-enterprise,openshift-origin - Name: Configuring your cluster logging deployment Dir: config + Distros: openshift-enterprise,openshift-origin Topics: - Name: About configuring cluster logging File: efk-logging-configuring-about @@ -722,12 +732,16 @@ Topics: File: efk-logging-external - Name: Viewing Elasticsearch status File: efk-logging-elasticsearch-status + Distros: openshift-enterprise,openshift-origin - Name: Manually rolling out Elasticsearch File: efk-logging-manual-rollout + Distros: openshift-enterprise,openshift-origin - Name: Troubleshooting Kibana File: efk-logging-troubleshooting + Distros: openshift-enterprise,openshift-origin - Name: Exported fields File: efk-logging-exported-fields + Distros: openshift-enterprise,openshift-origin - Name: Uninstalling cluster logging File: efk-logging-uninstall --- diff --git a/logging/dedicated-efk-deploying.adoc b/logging/dedicated-efk-deploying.adoc new file mode 100644 index 0000000000..d78da03720 --- /dev/null +++ b/logging/dedicated-efk-deploying.adoc @@ -0,0 +1,8 @@ +:context: dedicated-efk-deploying +[id="dedicated-efk-deploying"] += Installing the Cluster Logging and Elasticsearch Operators +include::modules/common-attributes.adoc[] + +toc::[] + +include::modules/efk-logging-deploy-subscription.adoc[leveloffset=+1] diff --git a/logging/dedicated-efk-logging.adoc b/logging/dedicated-efk-logging.adoc new file mode 100644 index 0000000000..4be2442b30 --- /dev/null +++ b/logging/dedicated-efk-logging.adoc @@ -0,0 +1,65 @@ +:context: dedicated-efk-logging +[id="dedicated-efk-logging"] += Configuring cluster logging in {product-title} +include::modules/common-attributes.adoc[] + +As an {product-title} cluster administrator, you can deploy cluster logging +to aggregate logs for a range of services. + +{product-title} clusters can perform logging tasks using the ElasticSearch +Operator. Cluster logging is configured through the Curator tool to retain logs +for two days. + +Cluster logging is configurable using a Cluster Logging Custom Resource (CR) +deployed in the `openshift-logging` project namespace. + +The Cluster Logging Operator watches for changes to Cluster Logging CRs, creates +any missing logging components, and adjusts the logging deployment accordingly. + +The Cluster Logging CR is based on the Cluster Logging Custom Resource +Definition (CRD), which defines a complete cluster logging deployment and +includes all the components of the logging stack to collect, store and visualize +logs. + +.Sample Cluster Logging Custom Resource (CR) +[source,yaml] +---- +apiVersion: "logging.openshift.io/v1" +kind: "ClusterLogging" +metadata: + name: "instance" + namespace: "openshift-logging" +spec: + managementState: "Managed" + logStore: + type: "elasticsearch" + elasticsearch: + nodeCount: 3 + storage: + storageClassName: "gp2" + size: "200Gi" + redundancyPolicy: "SingleRedundancy" + nodeSelector: + node-role.kubernetes.io/worker: "" + resources: + request: + memory: 8G + visualization: + type: "kibana" + kibana: + replicas: 1 + nodeSelector: + node-role.kubernetes.io/worker: "" + curation: + type: "curator" + curator: + schedule: "30 3 * * *" + nodeSelector: + node-role.kubernetes.io/worker: "" + collection: + logs: + type: "fluentd" + fluentd: {} + nodeSelector: + node-role.kubernetes.io/worker: "" +---- diff --git a/modules/efk-logging-about-crd.adoc b/modules/efk-logging-about-crd.adoc index 8f7d0dcc99..f0cd450158 100644 --- a/modules/efk-logging-about-crd.adoc +++ b/modules/efk-logging-about-crd.adoc @@ -15,12 +15,57 @@ The following is an example of a typical Custom Resource for cluster logging. [id="efk-logging-configuring-about-sample_{context}"] .Sample Cluster Logging CR +ifdef::openshift-dedicated[] [source,yaml] ---- apiVersion: "logging.openshift.io/v1" kind: "ClusterLogging" metadata: - name: "instance" + name: "instance" + namespace: "openshift-logging" +spec: + managementState: "Managed" + logStore: + type: "elasticsearch" + elasticsearch: + nodeCount: 3 + storage: + storageClassName: "gp2" + size: "200Gi" + redundancyPolicy: "SingleRedundancy" + nodeSelector: + node-role.kubernetes.io/worker: "" + resources: + request: + memory: 8G + visualization: + type: "kibana" + kibana: + replicas: 1 + nodeSelector: + node-role.kubernetes.io/worker: "" + curation: + type: "curator" + curator: + schedule: "30 3 * * *" + nodeSelector: + node-role.kubernetes.io/worker: "" + collection: + logs: + type: "fluentd" + fluentd: {} + nodeSelector: + node-role.kubernetes.io/worker: "" +---- +endif::[] + +ifdef::openshift-enterprise,openshift-origin[] +[source,yaml] +---- +apiVersion: "logging.openshift.io/v1" +kind: "ClusterLogging" +metadata: + name: "instance" namespace: openshift-logging spec: managementState: "Managed" @@ -76,3 +121,4 @@ spec: cpu: 200m memory: 1Gi ---- +endif::[]