From e8beb95f2137df595d29874b79f4764ca8a9db70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?= <“nicoshishkinatlogz@outlook.com”> Date: Tue, 31 Oct 2023 09:55:31 +0000 Subject: [PATCH 1/2] Control plane logs --- docs/shipping/Containers/control-plane.md | 87 +++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 docs/shipping/Containers/control-plane.md diff --git a/docs/shipping/Containers/control-plane.md b/docs/shipping/Containers/control-plane.md new file mode 100644 index 00000000..06a0624c --- /dev/null +++ b/docs/shipping/Containers/control-plane.md @@ -0,0 +1,87 @@ +--- +id: Control-plane +title: Control Plane +overview: Control Plane is a hybrid platform that integrates multiple cloud services, such as AWS, GCP, and Azure, providing a unified and flexible environment for developers to build and manage backend applications and services across various public and private clouds. +product: ['logs'] +os: ['windows', 'linux'] +filters: ['Containers', 'Most Popular'] +logo: https://logzbucket.s3.eu-west-1.amazonaws.com/logz-docs/shipper-logos/control-plane.png +logs_dashboards: [] +logs_alerts: [] +logs2metrics: [] +metrics_dashboards: [] +metrics_alerts: [] +drop_filter: [] +--- + +## Logs + +Control Plane is a hybrid platform that integrates multiple cloud services, such as AWS, GCP, and Azure, providing a unified and flexible environment for developers to build and manage backend applications and services across various public and private clouds. + +Deploy this integration to ship all `Org` logs from your Control Plane account to Logz.io. + +**Before you begin, you'll need**: + +* Control Plane account + + + +### Store the Logz.io secret as an Opaque Secret + +1. Log in to [Control Plane Console UI](https://console.cpln.io/). +2. Navigate to **Secrets**. +3. Create a new secret. +4. Give the secret a name. +5. Select `Opaque` from the **Secret Type list**. +6. Paste `<>` into the content text box. +7. Click **Create**. + +{@include: ../../_include/log-shipping/log-shipping-token.html} + +### Enable Control Plane logging + +#### Using the UI Console + +1. Open the [Control Plane Console UI](https://console.cpln.io/). +2. Click on **Org** in the left menu. +3. Click **External Logs** in the middle context menu. +4. Select `Logz.io` and fill out the required fields. +5. Select the Opaque secret created to authenticate to Logz.io. +6. Click **Save**. + +#### Using the CLI + +1. Prepare the YAML manifest: + +```yaml +kind: org +name: ORG_NAME +spec: + logging: + logzio: + credentials: //secret/<> + listenerHost: <> +``` + +Replace `ORG_NAME` with your organization's name. + +{@include: ../../_include/log-shipping/log-shipping-token.html} + +{@include: ../../_include/log-shipping/listener-var.html} + +2. Save the file, for example, `logging-config.yaml`. + +3. Open your command line interface (CLI) and navigate to the directory where the `logging-config.yaml` file is saved. + +4. Execute the following command, replacing `ORG_NAME` with your organization's name: + +```shell +cpln org patch ORG_NAME -f logging-config.yaml +``` + + +#### Check Logz.io for your logs + +Spin up your Docker containers if you haven't done so already. Give your logs some time to get from your system to ours, and then open [Open Search Dashboards](https://app.logz.io/#/dashboard/osd). + +If you still don't see your logs, see [log shipping troubleshooting]({{site.baseurl}}/user-guide/log-shipping/log-shipping-troubleshooting.html). From c19211d43dcce7602723a29f72c6401e3e286800 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?= <“nicoshishkinatlogz@outlook.com”> Date: Wed, 1 Nov 2023 11:35:15 +0000 Subject: [PATCH 2/2] Algolia search --- docusaurus.config.js | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index e720a36a..910db0df 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -32,12 +32,7 @@ const config = { }, plugins: [ - [ - '@cmfcmf/docusaurus-search-local', - { - // Add your options here, if any - }, - ], + [ 'docusaurus-plugin-includes', { @@ -101,6 +96,35 @@ const config = { themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ + algolia: { + // The application ID provided by Algolia + appId: 'WJRQN4A3SB', + + // Public API key: it is safe to commit it + apiKey: '062ce43eeca6e9f1410d3d2f435765c5', + + indexName: 'GAVMESY4FI', + + // Optional: see doc section below + contextualSearch: true, + + // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them. + externalUrlRegex: 'external\\.com|domain\\.com', + + // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs + replaceSearchResultPathname: { + from: '/docs/', // or as RegExp: /\/docs\// + to: '/', + }, + + // Optional: Algolia search parameters + searchParameters: {}, + + // Optional: path for search page that enabled by default (`false` to disable it) + searchPagePath: 'search', + + //... other Algolia params + }, docs: { sidebar: { hideable: true,