[Cloud plugin] Added README text (elastic#97999) (elastic#98153)

* Added README text * Update x-pack/plugins/cloud/README.md Co-authored-by: Alejandro Fernández Haro <[email protected]> * Updated README.md * Updated docs build Co-authored-by: Alejandro Fernández Haro <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Alejandro Fernández Haro <[email protected]> Co-authored-by: Kibana Machine <[email protected]>
stratoula · Apr 26, 2021 · ba19c86 · ba19c86
1 parent 8b41ca1
commit ba19c86
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git 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
@@ -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