Skip to content

Commit

Permalink
Add more details to and reformat the Cloud plugin README. (#109529)
Browse files Browse the repository at this point in the history
  • Loading branch information
cjcenizal authored Aug 23, 2021
1 parent 6f7ded9 commit d07c733
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 11 deletions.
3 changes: 1 addition & 2 deletions docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,7 @@ The plugin exposes the static DefaultEditorController class to consume.
|{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:
|The cloud plugin adds Cloud-specific features to Kibana.
|{kib-repo}blob/{branch}/x-pack/plugins/cross_cluster_replication/README.md[crossClusterReplication]
Expand Down
54 changes: 45 additions & 9 deletions x-pack/plugins/cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,47 @@
# `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
The `cloud` plugin adds Cloud-specific features to Kibana.

## Client-side API

The client-side plugin provides the following interface.

### `isCloudEnabled`

This is set to `true` for both ESS and ECE deployments.

### `cloudId`

This is the ID of the Cloud deployment to which the Kibana instance belongs.

**Example:** `eastus2.azure.elastic-cloud.com:9243$59ef636c6917463db140321484d63cfa$a8b109c08adc43279ef48f29af1a3911`

### `baseUrl`

This is the URL of the Cloud interface.

**Example:** `https://cloud.elastic.co` (on the ESS production environment)

### `deploymentUrl`

This is the path to the Cloud deployment management page for the deployment to which the Kibana instance belongs. The value is already prepended with `baseUrl`.

**Example:** `{baseUrl}/deployments/bfdad4ef99a24212a06d387593686d63`

### `profileUrl`

This is the path to the Cloud User Profile page. The value is already prepended with `baseUrl`.

**Example:** `{baseUrl}/user/settings/`

### `organizationUrl`

This is the path to the Cloud Account and Billing page. The value is already prepended with `baseUrl`.

**Example:** `{baseUrl}/account/`

### `cname`

This value is the same as `baseUrl` on ESS but can be customized on ECE.

**Example:** `cloud.elastic.co` (on ESS)

0 comments on commit d07c733

Please sign in to comment.