Skip to content

Commit

Permalink
[DOCS] Updates links to Stack Overview (#48582)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Oct 17, 2019
1 parent 56b96e5 commit ed9abf0
Show file tree
Hide file tree
Showing 20 changed files with 32 additions and 32 deletions.
4 changes: 2 additions & 2 deletions docs/limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@

These {stack} features also have limitations that affect {kib}:

* {stack-ov}/watcher-limitations.html[Alerting]
* {ref}/watcher-limitations.html[Alerting]
* {stack-ov}/ml-limitations.html[Machine learning]
* {stack-ov}/security-limitations.html[Security]
* {ref}/security-limitations.html[Security]

--

Expand Down
2 changes: 1 addition & 1 deletion docs/management/dashboard_only_mode/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ does not provide access to data indices.
You must also assign the user a role that grants `read` access
to each index you are using. Use *Management > Security > Roles* to create or edit a
role and assign index privileges.
For information on roles and privileges, see {stack-ov}/authorization.html[User authorization].
For information on roles and privileges, see {ref}/authorization.html[User authorization].

[role="screenshot"]
image:management/dashboard_only_mode/images/custom_dashboard_mode_role.png["Dashboard Only mode has no editing controls"]
Expand Down
2 changes: 1 addition & 1 deletion docs/management/managing-licenses.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ license, extend the trial, or purchase a subscription.

TIP: If {security-features} are enabled, before you revert to a Basic license or install
a Gold or Platinum license, you must configure Transport Layer Security (TLS) in {es}.
See {stack-ov}/encrypting-communications.html[Encrypting communications].
See {ref}/encrypting-communications.html[Encrypting communications].
2 changes: 1 addition & 1 deletion docs/management/managing-remote-clusters.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before using these features, you should be familiar with the following concepts:

* {ref}/xpack-ccr.html[{ccr-cap}]
* {ref}/modules-cross-cluster-search.html[{ccs-cap}]
* {stack-ov}/cross-cluster-configuring.html[Cross-cluster security requirements]
* {ref}/cross-cluster-configuring.html[Cross-cluster security requirements]

[float]
[[managing-remote-clusters]]
Expand Down
2 changes: 1 addition & 1 deletion docs/management/watcher-ui/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ watch—input, schedule, condition, and actions.
=== Watcher security

If the {es} {security-features} are enabled, you must have the
{stack-ov}/security-privileges.html[`manage_watcher` or `monitor_watcher`]
{ref}/security-privileges.html[`manage_watcher` or `monitor_watcher`]
cluster privileges to use Watcher in {kib}.

Alternately, you can have the built-in `kibana_user` role
Expand Down
2 changes: 1 addition & 1 deletion docs/settings/monitoring-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ from Logstash, you configure
in `logstash.yml`.

For more information, see
{stack-ov}/xpack-monitoring.html[Monitoring the Elastic Stack].
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].

[float]
[[monitoring-general-settings]]
Expand Down
6 changes: 3 additions & 3 deletions docs/settings/ssl-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
=== {component} TLS/SSL settings
You can configure the following TLS/SSL settings. If the settings are not
configured, the default values are used. See
{stack-ov}/security-settings.html[Default TLS/SSL Settings].
{ref}/security-settings.html[Default TLS/SSL Settings].

ifdef::server[]
+{ssl-prefix}.ssl.enabled+::
Expand Down Expand Up @@ -45,7 +45,7 @@ Java Cryptography Architecture documentation]. Defaults to the value of
The following settings are used to specify a private key, certificate, and the
trusted certificates that should be used when communicating over an SSL/TLS connection.
If none of the settings below are specified, the default values are used.
See {stack-ov}/security-settings.html[Default TLS/SSL settings].
See {ref}/security-settings.html[Default TLS/SSL settings].

ifdef::server[]
A private key and certificate must be configured.
Expand All @@ -55,7 +55,7 @@ A private key and certificate are optional and would be used if the server requi
authentication.
endif::server[]
If none of the settings below are specified, the defaults values are used.
See {stack-ov}/security-settings.html[Default TLS/SSL settings].
See {ref}/security-settings.html[Default TLS/SSL settings].

[float]
===== PEM encoded files
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/production.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ and an Elasticsearch client node on the same machine. For more information, see
[[configuring-kibana-shield]]
=== Using {stack} {security-features}

You can use {stack-ov}/elasticsearch-security.html[{stack} {security-features}]
to control what {es} data users can access through Kibana.
You can use {stack} {security-features} to control what {es} data users can
access through Kibana.

When {security-features} are enabled, Kibana users have to log in. They need to
have a role granting <<kibana-privileges, Kibana privileges>> as well as access
Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/configuring-monitoring.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can also use {kib} to
<<monitoring-data,visualize monitoring data from across the {stack}>>.

To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].

include::monitoring-kibana.asciidoc[]
include::monitoring-metricbeat.asciidoc[]
Expand Down
4 changes: 2 additions & 2 deletions docs/user/monitoring/elasticsearch-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,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
{stack-ov}/watch-cluster-status.html[Watch Your Cluster Health].
{ref}/watch-cluster-status.html[Watching the status of an {es} cluster].

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
Expand Down Expand Up @@ -145,7 +145,7 @@ You can also see advanced information, which contains the results from the
[role="screenshot"]
image::user/monitoring/images/monitoring-ccr-shard.png["Cross-cluster replication shard details",link="images/monitoring-ccr-shard.png"]

For more information, see {stack-ov}/xpack-ccr.html[Cross-cluster replication].
For more information, see {ref}/xpack-ccr.html[{ccr-cap}].

[float]
[[logs-monitor-page]]
Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ NOTE: Watcher must be enabled to view cluster alerts. If you have a Basic
license, Top Cluster Alerts are not displayed.

For more information, see <<configuring-monitoring>> and
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].

--

Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/monitoring-kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ which ultimately routes them to the monitoring cluster. For an alternative
method, see <<monitoring-metricbeat>>.

To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].

. Set the `xpack.monitoring.collection.enabled` setting to `true` on each
node in the production cluster. By default, it is is disabled (`false`).
Expand Down
10 changes: 5 additions & 5 deletions docs/user/monitoring/monitoring-metricbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ production cluster as described in <<monitoring-kibana>>.
image::user/monitoring/images/metricbeat.png[Example monitoring architecture]

To learn about monitoring in general, see
{stack-ov}/xpack-monitoring.html[Monitoring the {stack}].
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].

//NOTE: The tagged regions are re-used in the Stack Overview.

Expand Down Expand Up @@ -134,9 +134,9 @@ If the Elastic {security-features} are enabled, you must also provide a user
ID and password so that {metricbeat} can collect metrics successfully:

.. Create a user on the production cluster that has the
`remote_monitoring_collector` {stack-ov}/built-in-roles.html[built-in role].
`remote_monitoring_collector` {ref}/built-in-roles.html[built-in role].
Alternatively, use the `remote_monitoring_user`
{stack-ov}/built-in-users.html[built-in user].
{ref}/built-in-users.html[built-in user].

.. Add the `username` and `password` settings to the {kib} module configuration
file.
Expand Down Expand Up @@ -197,9 +197,9 @@ must provide a valid user ID and password so that {metricbeat} can send metrics
successfully:

.. Create a user on the monitoring cluster that has the
`remote_monitoring_agent` {stack-ov}/built-in-roles.html[built-in role].
`remote_monitoring_agent` {ref}/built-in-roles.html[built-in role].
Alternatively, use the `remote_monitoring_user`
{stack-ov}/built-in-users.html[built-in user].
{ref}/built-in-users.html[built-in user].

.. Add the `username` and `password` settings to the {es} output information in
the {metricbeat} configuration file.
Expand Down
4 changes: 2 additions & 2 deletions docs/user/monitoring/viewing-metrics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ default value, in the `kibana.yml` file. For more information, see
must provide a user ID and password so {kib} can retrieve the data.

.. Create a user that has the `monitoring_user`
{stack-ov}/built-in-roles.html[built-in role] on the monitoring cluster.
{ref}/built-in-roles.html[built-in role] on the monitoring cluster.

.. Add the `xpack.monitoring.elasticsearch.username` and
`xpack.monitoring.elasticsearch.password` settings in the `kibana.yml` file.
Expand All @@ -64,7 +64,7 @@ remote monitoring cluster, you must use credentials that are valid on both the
--

.. Create users that have the `monitoring_user` and `kibana_user`
{stack-ov}/built-in-roles.html[built-in roles].
{ref}/built-in-roles.html[built-in roles].

. Open {kib} in your web browser.
+
Expand Down
2 changes: 1 addition & 1 deletion docs/user/reporting/gs-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following Reporting button appears in the {kib} toolbar:

image:images/reporting.jpg["Reporting",link="reporting.jpg"]

You can also {stack-ov}/automating-report-generation.html[generate reports automatically].
You can also <<automating-report-generation,generate reports automatically>>.

IMPORTANT: Reports are stored in the `.reporting-*` indices. Any user with
access to these indices has access to every report generated by all users.
Expand Down
2 changes: 1 addition & 1 deletion docs/user/reporting/watch-example.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ report from the Kibana UI.
NOTE: Reporting is integrated with Watcher only as an email attachment type.

For more information about configuring watches, see
{stack-ov}/how-watcher-works.html[How Watcher Works].
{ref}/how-watcher-works.html[How Watcher works].
2 changes: 1 addition & 1 deletion docs/user/security/audit-logging.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ audit logging to get a holistic view of all security related events.
{kib} defers to {es}'s security model for authentication, data
index authorization, and features that are driven by cluster-wide privileges.
For more information on enabling audit logging in {es}, see
{stack-ov}/auditing.html[Auditing Security Events].
{ref}/auditing.html[Auditing security events].

[IMPORTANT]
============================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/user/security/authorization/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[xpack-security-authorization]]

=== Granting access to {kib}
The Elastic Stack comes with the `kibana_user` {stack-ov}/built-in-roles.html[built-in role], which you can use to grant access to all Kibana features in all spaces. To grant users access to a subset of spaces or features, you can create a custom role that grants the desired Kibana privileges.
The Elastic Stack comes with the `kibana_user` {ref}/built-in-roles.html[built-in role], which you can use to grant access to all Kibana features in all spaces. To grant users access to a subset of spaces or features, you can create a custom role that grants the desired Kibana privileges.

When you assign a user multiple roles, the user receives a union of the roles’ privileges. Therefore, assigning the `kibana_user` role in addition to a custom role that grants Kibana privileges is ineffective because `kibana_user` has access to all the features in all spaces.

Expand Down
6 changes: 3 additions & 3 deletions docs/user/security/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ security, you can
password-protect your data as well as implement more advanced security measures
such as encrypting communications, role-based access control, IP filtering, and
auditing. For more information, see
{stack-ov}/elasticsearch-security.html[Securing {es} and {kib}] and
{ref}/secure-cluster.html[Secure a cluster] and
<<using-kibana-with-security,Configuring Security in {kib}>>.

[float]
Expand All @@ -16,7 +16,7 @@ auditing. For more information, see
You can create and manage users on the *Management -> Security -> Users* page.
You can also change their passwords and roles. For more information about
authentication and built-in users, see
{stack-ov}/setting-up-authentication.html[Setting up user authentication].
{ref}/setting-up-authentication.html[Setting up user authentication].

[float]
=== Roles
Expand All @@ -25,7 +25,7 @@ You can manage roles on the *Management -> Security -> Roles* page, or use
the <<role-management-api>>. For more information on configuring roles for {kib}, see <<xpack-security-authorization, Granting access to {kib}>>.

For a more holistic overview of configuring roles for the entire stack,
see {stack-ov}/authorization.html[Configuring role-based access control].
see {ref}/authorization.html[User authorization].

[NOTE]
============================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/user/security/securing-kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ APIs and the `.kibana` index. The server does _not_ need access to user indices.

The password for the built-in `kibana` user is typically set as part of the
{security} configuration process on {es}. For more information, see
{stack-ov}/built-in-users.html[Built-in users].
{ref}/built-in-users.html[Built-in users].
--

. Set the `xpack.security.encryptionKey` property in the `kibana.yml`
Expand Down

0 comments on commit ed9abf0

Please sign in to comment.