From 583906db9f940995f9849a72158fade93cf0cf42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yulia=20=C4=8Cech?= <6585477+yuliacech@users.noreply.github.com> Date: Fri, 23 Apr 2021 17:08:22 +0200 Subject: [PATCH] [Cloud plugin] Added README text (#97999) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added README text * Update x-pack/plugins/cloud/README.md Co-authored-by: Alejandro Fernández Haro * Updated README.md * Updated docs build Co-authored-by: Alejandro Fernández Haro Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- docs/developer/plugin-list.asciidoc | 1 + x-pack/plugins/cloud/README.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 5555dc8ac6d7b..657aa790ad028 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -339,6 +339,7 @@ Failure to have auth enabled in Kibana will make for a broken UI. UI-based error |{kib-repo}blob/{branch}/x-pack/plugins/cloud/README.md[cloud] |The cloud plugin adds cloud specific features to Kibana. +The client-side plugin configures following values: |{kib-repo}blob/{branch}/x-pack/plugins/code[code] diff --git a/x-pack/plugins/cloud/README.md b/x-pack/plugins/cloud/README.md index 13172e0a6ddc0..3fe0b3c8b8415 100644 --- a/x-pack/plugins/cloud/README.md +++ b/x-pack/plugins/cloud/README.md @@ -1,3 +1,11 @@ # `cloud` plugin The `cloud` plugin adds cloud specific features to Kibana. +The client-side plugin configures following values: +- `isCloudEnabled = true` for both ESS and ECE deployments +- `cloudId` is the ID of the Cloud deployment Kibana is running on +- `baseUrl` is the URL of the Cloud interface, for Elastic Cloud production environment the value is `https://cloud.elastic.co` +- `deploymentUrl` is the URL of the specific Cloud deployment Kibana is running on, the value is already concatenated with `baseUrl` +- `profileUrl` is the URL of the Cloud user profile page, the value is already concatenated with `baseUrl` +- `organizationUrl` is the URL of the Cloud account (& billing) page, the value is already concatenated with `baseUrl` +- `cname` value is the same as `baseUrl` on ESS but can be customized on ECE