/docs/observability/monitoring/configure/grafana/ Recent content in Grafana on Verrazzano Enterprise Container Platform Hugo -- gohugo.io /docs/observability/monitoring/configure/grafana/grafana/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/observability/monitoring/configure/grafana/grafana/ <h3 id="configure-a-grafana-database">Configure a Grafana database</h3> <p>By default, Verrazzano automatically installs and configures a Grafana database. However, you can use your own external database.</p> <p>If you prefer to use your own Grafana database, complete the following steps:</p> <ol> <li> <p>Create a secret named <code>grafana-db</code> in the <code>verrazzano-install</code> namespace which contains the login credentials. For example: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre tabindex="0"><code>$ ROOT_SECRET=$(echo &lt;database root user secret&gt; | base64) $ USER=$(echo &lt;database user&gt; | base64) $ USER_SECRET=$(echo &lt;database user secret&gt; | base64) $ kubectl apply -f - &lt;&lt;-EOF apiVersion: v1 kind: Secret metadata: name: grafana-db namespace: verrazzano-install type: Opaque data: root-password: $ROOT_SECRET username: $USER password: $USER_SECRET EOF </code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>Configure the Grafana component of the Verrazzano custom resource. For example: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre tabindex="0"><code>apiVersion: install.verrazzano.io/v1beta1 kind: Verrazzano metadata: name: grafana-db-example spec: profile: dev components: grafana: database: host: mysql.verrazzano-install.svc.cluster.local name: grafana </code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> </ol> <h3 id="configure-an-smtp-server">Configure an SMTP server</h3> <p>To configure Grafana to send SMTP notifications, complete the following steps:</p> <ol> <li> <p>Create a secret named <code>smtp-secret</code> in the <code>verrazzano-system</code> namespace which contains the SMTP server credentials. For example: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre tabindex="0"><code>$ kubectl -n verrazzano-system create secret generic smtp-secret \ --from-literal=username=&#34;&lt;smtp server username&gt;&#34; \ --from-literal=password=&#34;&lt;smtp server password&gt;&#34; \ --from-file=cert=&lt;path to file containing certificate&gt; \ --from-file=key=&lt;path to file containing certificate key&gt; </code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>Configure the Grafana component of the Verrazzano custom resource. For example: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"> <pre tabindex="0"><code>apiVersion: install.verrazzano.io/v1beta1 kind: Verrazzano metadata: name: grafana-smtp-example spec: profile: dev components: grafana: smtp: certFileKey: &#34;cert&#34; ehloIdentity: &#34;&lt;Name to be used as client identity for EHLO in SMTP dialog&gt;&#34; enabled: true existingSecret: &#34;smtp-secret&#34; fromAddress: &#34;&lt;Address used when sending out emails&gt;&#34; fromName: &#34;&lt;Name to be used when sending out emails&gt;&#34; host: &#34;&lt;host or host:port for the smtp server&gt;&#34; passwordKey: &#34;password&#34; skipVerify: true startTLSPolicy: &#34;&#34; userKey: &#34;username&#34; keyFileKey: &#34;key&#34; </code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> </ol> <p>For more information about Grafana SMTP configurations, see the <a href="https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#smtp">Grafana Documentation</a>.</p> <p>For more information about the component definition, see <a href="../../../../../docs/reference/vpo-verrazzano-v1beta1/#install.verrazzano.io/v1beta1.GrafanaComponent">Grafana component</a> in the Verrazzano custom resource.</p>