From 41d9e8e252bc912c615fe5d70cd3a29392e766c1 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 29 Nov 2019 18:20:52 -0800 Subject: [PATCH] [6.6] [DOCS] Fixes broken links (#51634) (#51929) --- docs/api/role-management/put.asciidoc | 2 +- docs/development/security/rbac.asciidoc | 2 +- docs/getting-started/tutorial-load-dataset.asciidoc | 2 +- docs/getting-started/tutorial-sample-data.asciidoc | 2 +- .../dashboard_only_mode/advanced_configuration.asciidoc | 2 +- docs/management/dashboard_only_mode/index.asciidoc | 2 +- docs/management/managing-indices.asciidoc | 2 +- docs/ml/job-tips.asciidoc | 4 ++-- docs/monitoring/elasticsearch-details.asciidoc | 2 +- docs/security/authentication/index.asciidoc | 4 ++-- docs/security/reporting.asciidoc | 8 ++++---- docs/security/securing-kibana.asciidoc | 2 +- docs/settings/monitoring-settings.asciidoc | 2 +- docs/setup/docker.asciidoc | 2 +- docs/setup/install.asciidoc | 2 +- docs/setup/install/deb.asciidoc | 2 +- docs/setup/install/rpm.asciidoc | 2 +- docs/setup/install/targz.asciidoc | 2 +- docs/setup/install/windows.asciidoc | 2 +- 19 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/api/role-management/put.asciidoc b/docs/api/role-management/put.asciidoc index c00b5e6b387e0..91e65f6385dda 100644 --- a/docs/api/role-management/put.asciidoc +++ b/docs/api/role-management/put.asciidoc @@ -28,7 +28,7 @@ The following parameters can be specified in the body of a PUT request to add or that begin with `_` are reserved for system usage. `elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are -`cluster`, `indices` and `run_as`. For more information, see {xpack-ref}/defining-roles.html[Defining Roles]. +`cluster`, `indices` and `run_as`. For more information, see {ref}/defining-roles.html[Defining roles]. `kibana`:: (object) An object that specifies the <>. Valid keys are `global` and `space`. Privileges defined in the `global` key will apply to all spaces within Kibana, and will take precedent over any privileges defined in the `space` key. For example, specifying `global: ["all"]` will grant full access to all spaces within Kibana, even if the role indicates that a specific space should only have `read` privileges. diff --git a/docs/development/security/rbac.asciidoc b/docs/development/security/rbac.asciidoc index 5651c776360c1..9db9dbc0afa8c 100644 --- a/docs/development/security/rbac.asciidoc +++ b/docs/development/security/rbac.asciidoc @@ -1,7 +1,7 @@ [[development-security-rbac]] === Role-based access control -Role-based access control (RBAC) in {kib} relies upon the {xpack-ref}/security-privileges.html#application-privileges[application privileges] that Elasticsearch exposes. This allows {kib} to define the privileges that {kib} wishes to grant to users, assign them to the relevant users using roles, and then authorize the user to perform a specific action. This is handled within a secured instance of the `SavedObjectsClient` and available transparently to consumers when using `request.getSavedObjectsClient()` or `savedObjects.getScopedSavedObjectsClient()`. +Role-based access control (RBAC) in {kib} relies upon the {ref}/security-privileges.html#application-privileges[application privileges] that Elasticsearch exposes. This allows {kib} to define the privileges that {kib} wishes to grant to users, assign them to the relevant users using roles, and then authorize the user to perform a specific action. This is handled within a secured instance of the `SavedObjectsClient` and available transparently to consumers when using `request.getSavedObjectsClient()` or `savedObjects.getScopedSavedObjectsClient()`. [[development-rbac-privileges]] ==== {kib} Privileges diff --git a/docs/getting-started/tutorial-load-dataset.asciidoc b/docs/getting-started/tutorial-load-dataset.asciidoc index d23d50baed662..7c1b8649ffa70 100644 --- a/docs/getting-started/tutorial-load-dataset.asciidoc +++ b/docs/getting-started/tutorial-load-dataset.asciidoc @@ -65,7 +65,7 @@ and whether it's _tokenized_, or broken up into separate words. NOTE: If security is enabled, you must have the `all` Kibana privilege to run this tutorial. You must also have the `create`, `manage` `read`, `write,` and `delete` -index privileges. See {xpack-ref}/security-privileges.html[Security Privileges] +index privileges. See {ref}/security-privileges.html[Security privileges] for more information. In Kibana *Dev Tools > Console*, set up a mapping for the Shakespeare data set: diff --git a/docs/getting-started/tutorial-sample-data.asciidoc b/docs/getting-started/tutorial-sample-data.asciidoc index d064f41c65073..c0491a39a7fdb 100644 --- a/docs/getting-started/tutorial-sample-data.asciidoc +++ b/docs/getting-started/tutorial-sample-data.asciidoc @@ -26,6 +26,6 @@ In this tutorial, you’ll learn to: * Inspect the data behind the scenes NOTE: If security is enabled, you must have `read`, `write`, and `manage` privileges -on the `kibana_sample_data_*` indices. See {xpack-ref}/security-privileges.html[Security Privileges] +on the `kibana_sample_data_*` indices. See {ref}/security-privileges.html[Security privileges] for more information. diff --git a/docs/management/dashboard_only_mode/advanced_configuration.asciidoc b/docs/management/dashboard_only_mode/advanced_configuration.asciidoc index 44b59c51cb073..4a6cc5a5ba0cc 100644 --- a/docs/management/dashboard_only_mode/advanced_configuration.asciidoc +++ b/docs/management/dashboard_only_mode/advanced_configuration.asciidoc @@ -19,7 +19,7 @@ To grant read-only access to your custom {kib} instance, you must assign the read <>. These privileges are available under *Management > Security > Roles*. -For more information on roles and privileges, see {xpack-ref}/authorization.html[User Authorization]. +For more information on roles and privileges, see {ref}/authorization.html[User authorization]. [role="screenshot"] image:management/dashboard_only_mode/images/custom_dashboard_mode_role.png["Custom dashboard mode role with read permissions on a custom kibana index"] diff --git a/docs/management/dashboard_only_mode/index.asciidoc b/docs/management/dashboard_only_mode/index.asciidoc index e9acad28a8561..b64c3ae19945a 100644 --- a/docs/management/dashboard_only_mode/index.asciidoc +++ b/docs/management/dashboard_only_mode/index.asciidoc @@ -7,7 +7,7 @@ what users see when they log in to {kib}. The `kibana_dashboard_only_user` role preconfigured with read-only permissions to {kib}. IMPORTANT: You must also assign roles that grant the user appropriate access to the data indices. -For information on roles and privileges, see {xpack-ref}/authorization.html[User Authorization]. +For information on roles and privileges, see {ref}/authorization.html[User authorization]. Users assigned this role are only able to see the Dashboard app in the navigation pane. When users open a dashboard, they will have a limited visual experience. diff --git a/docs/management/managing-indices.asciidoc b/docs/management/managing-indices.asciidoc index a696d31cae0d4..4e86356ba239a 100644 --- a/docs/management/managing-indices.asciidoc +++ b/docs/management/managing-indices.asciidoc @@ -11,7 +11,7 @@ perform bulk operations on multiple indices. To open the UI, select *Management > Index Management*. If security is enabled, you must have the the `monitor` cluster privilege and the `view_index_metadata` and `manage` index privileges to view the data. See -{xpack-ref}/security-privileges.html[Security Privileges] for more +{ref}/security-privileges.html[Security privileges] for more information. [role="screenshot"] diff --git a/docs/ml/job-tips.asciidoc b/docs/ml/job-tips.asciidoc index 2e5df33d727c2..885e1dd8bccda 100644 --- a/docs/ml/job-tips.asciidoc +++ b/docs/ml/job-tips.asciidoc @@ -22,7 +22,7 @@ see {ref}/ml-job-resource.html#ml-analysisconfig[Analysis configuration objects] If you choose a value that is larger than one day or is significantly different than the estimated value, you receive an informational message. For more information about choosing an appropriate bucket span, see -{xpack-ref}/ml-buckets.html[Buckets]. +{stack-ov}/ml-buckets.html[Buckets]. [[cardinality]] ==== Cardinality @@ -40,7 +40,7 @@ job uses more memory resources. In particular, if the cardinality of the Likewise if you are performing population analysis and the cardinality of the `over_field_name` is below 10, you are advised that this might not be a suitable field to use. For more information, see -{xpack-ref}/ml-configuring-pop.html[Performing Population Analysis]. +{stack-ov}/ml-configuring-pop.html[Performing population analysis]. [[detectors]] ==== Detectors diff --git a/docs/monitoring/elasticsearch-details.asciidoc b/docs/monitoring/elasticsearch-details.asciidoc index dd48b1663beda..e97fd12f3cf04 100644 --- a/docs/monitoring/elasticsearch-details.asciidoc +++ b/docs/monitoring/elasticsearch-details.asciidoc @@ -23,7 +23,7 @@ highlighted in yellow or red. TIP: Conditions that require your attention are listed at the top of the Clusters page. You can also set up watches to alert you when the status of your cluster changes. To learn how, see -{xpack-ref}/watch-cluster-status.html[Watch Your Cluster Health]. +{ref}/watch-cluster-status.html[Watch your cluster health]. The panel at the top shows the current cluster statistics, the charts show the search and indexing performance over time, and the table at the bottom shows diff --git a/docs/security/authentication/index.asciidoc b/docs/security/authentication/index.asciidoc index 9839975eaee14..2a352ab392fd4 100644 --- a/docs/security/authentication/index.asciidoc +++ b/docs/security/authentication/index.asciidoc @@ -12,11 +12,11 @@ ==== Basic Authentication -Basic Authentication requires a username and password to successfully log in to {kib}. It is enabled by default and based on the Native security realm provided by {es}. For more information about Basic Authentication and built-in users, see {xpack-ref}/setting-up-authentication.html[Setting Up User Authentication]. +Basic Authentication requires a username and password to successfully log in to {kib}. It is enabled by default and based on the Native security realm provided by {es}. For more information about Basic Authentication and built-in users, see {ref}/setting-up-authentication.html[User authentication]. ==== SAML Single Sign-On -SAML authentication allows users to log in to {kib} with an external Identity Provider, such as Okta or Auth0. Make sure that SAML is enabled and configured in {es} before setting it up in {kib}. See {xpack-ref}/saml-guide.html[Configuring SAML Single-Sign-On on the Elastic Stack]. +SAML authentication allows users to log in to {kib} with an external Identity Provider, such as Okta or Auth0. Make sure that SAML is enabled and configured in {es} before setting it up in {kib}. See {ref}/saml-guide.html[Configuring SAML single sign-on on the Elastic Stack]. Set the configuration values in `kibana.yml` as follows: diff --git a/docs/security/reporting.asciidoc b/docs/security/reporting.asciidoc index 21a119bcb6e4b..188081bf44aa6 100644 --- a/docs/security/reporting.asciidoc +++ b/docs/security/reporting.asciidoc @@ -8,7 +8,7 @@ user actions in {kib}. To use {reporting} with {security} enabled, you need to <>. If you are automatically generating reports with -{xpack-ref}/xpack-alerting.html[{watcher}], you also need to configure {watcher} +{ref}/xpack-alerting.html[{watcher}], you also need to configure {watcher} to trust the {kib} server's certificate. For more information, see <>. @@ -34,7 +34,7 @@ POST /_xpack/security/user/reporter * If you are using an LDAP or Active Directory realm, you can either assign roles on a per user basis, or assign roles to groups of users. By default, role mappings are configured in -{xpack-ref}/mapping-roles.html[`config/shield/role_mapping.yml`]. +{ref}/mapping-roles.html[`config/shield/role_mapping.yml`]. For example, the following snippet assigns the user named Bill Murray the `kibana_user` and `reporting_user` roles: + @@ -54,7 +54,7 @@ In a production environment, you should restrict access to the {reporting} endpoints to authorized users. This requires that you: . Enable {security} on your {es} cluster. For more information, -see {xpack-ref}/security-getting-started.html[Getting Started with Security]. +see {ref}/security-getting-started.html[Getting started with security]. . Configure an SSL certificate for Kibana. For more information, see <>. . Configure {watcher} to trust the Kibana server's certificate by adding it to @@ -82,4 +82,4 @@ includes a watch that submits requests as the built-in `elastic` user: <>. For more information about configuring watches, see -{xpack-ref}/how-watcher-works.html[How Watcher Works]. +{ref}/how-watcher-works.html[How {watcher} works]. diff --git a/docs/security/securing-kibana.asciidoc b/docs/security/securing-kibana.asciidoc index 4d305945b6c13..15ca79d4c0992 100644 --- a/docs/security/securing-kibana.asciidoc +++ b/docs/security/securing-kibana.asciidoc @@ -106,7 +106,7 @@ TIP: You can define as many different roles for your {kib} users as you need. For example, create roles that have `read` and `view_index_metadata` privileges on specific index patterns. For more information, see -{xpack-ref}/authorization.html[Configuring Role-based Access Control]. +{ref}/authorization.html[User authorization]. -- diff --git a/docs/settings/monitoring-settings.asciidoc b/docs/settings/monitoring-settings.asciidoc index fa781308683ae..8bfab832694e7 100644 --- a/docs/settings/monitoring-settings.asciidoc +++ b/docs/settings/monitoring-settings.asciidoc @@ -25,7 +25,7 @@ from Logstash, you configure in `logstash.yml`. For more information, see -{xpack-ref}/xpack-monitoring.html[Monitoring the Elastic Stack]. +{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster]. [float] [[monitoring-general-settings]] diff --git a/docs/setup/docker.asciidoc b/docs/setup/docker.asciidoc index 8fa7cb7951f15..fe897ecc3754a 100644 --- a/docs/setup/docker.asciidoc +++ b/docs/setup/docker.asciidoc @@ -9,7 +9,7 @@ https://github.com/elastic/kibana-docker/tree/{branch}[GitHub]. These images are free to use under the Elastic license. They contain open source and free commercial features and access to paid commercial features. -{xpack-ref}/license-management.html[Start a 30-day trial] to try out all of the +{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the paid commercial features. See the https://www.elastic.co/subscriptions[Subscriptions] page for information about Elastic license levels. diff --git a/docs/setup/install.asciidoc b/docs/setup/install.asciidoc index d3a0d6e4e7815..e9e278ab40879 100644 --- a/docs/setup/install.asciidoc +++ b/docs/setup/install.asciidoc @@ -48,7 +48,7 @@ downloaded from the Elastic Docker Registry. <> IMPORTANT: If your Elasticsearch installation is protected by -{xpack-ref}/xpack-security.html[{security}] see +{ref}/elasticsearch-security.html[{security-features}] see {kibana-ref}/using-kibana-with-security.html[Configuring Security in Kibana] for additional setup instructions. diff --git a/docs/setup/install/deb.asciidoc b/docs/setup/install/deb.asciidoc index 0bfbccbaed2ba..b1e2d189ff14c 100644 --- a/docs/setup/install/deb.asciidoc +++ b/docs/setup/install/deb.asciidoc @@ -7,7 +7,7 @@ Kibana on any Debian-based system such as Debian and Ubuntu. This package is free to use under the Elastic license. It contains open source and free commercial features and access to paid commercial features. -{xpack-ref}/license-management.html[Start a 30-day trial] to try out all of the +{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the paid commercial features. See the https://www.elastic.co/subscriptions[Subscriptions] page for information about Elastic license levels. diff --git a/docs/setup/install/rpm.asciidoc b/docs/setup/install/rpm.asciidoc index 295ad10206b11..46889334ed0ba 100644 --- a/docs/setup/install/rpm.asciidoc +++ b/docs/setup/install/rpm.asciidoc @@ -11,7 +11,7 @@ such as SLES 11 and CentOS 5. Please see <> instead. This package is free to use under the Elastic license. It contains open source and free commercial features and access to paid commercial features. -{xpack-ref}/license-management.html[Start a 30-day trial] to try out all of the +{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the paid commercial features. See the https://www.elastic.co/subscriptions[Subscriptions] page for information about Elastic license levels. diff --git a/docs/setup/install/targz.asciidoc b/docs/setup/install/targz.asciidoc index f119a53b49180..a4c1d269e8af3 100644 --- a/docs/setup/install/targz.asciidoc +++ b/docs/setup/install/targz.asciidoc @@ -6,7 +6,7 @@ are the easiest formats to use when trying out Kibana. These packages are free to use under the Elastic license. They contain open source and free commercial features and access to paid commercial features. -{xpack-ref}/license-management.html[Start a 30-day trial] to try out all of the +{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the paid commercial features. See the https://www.elastic.co/subscriptions[Subscriptions] page for information about Elastic license levels. diff --git a/docs/setup/install/windows.asciidoc b/docs/setup/install/windows.asciidoc index b7f695062ae2c..d301a43778fbf 100644 --- a/docs/setup/install/windows.asciidoc +++ b/docs/setup/install/windows.asciidoc @@ -5,7 +5,7 @@ Kibana can be installed on Windows using the `.zip` package. This package is free to use under the Elastic license. It contains open source and free commercial features and access to paid commercial features. -{xpack-ref}/license-management.html[Start a 30-day trial] to try out all of the +{stack-ov}/license-management.html[Start a 30-day trial] to try out all of the paid commercial features. See the https://www.elastic.co/subscriptions[Subscriptions] page for information about Elastic license levels.