kib

Author: shainaraskas

deploy-manage/deploy/self-managed.md

@@ -7,14 +7,4 @@ sub:
 
 # Self-managed cluster [dependencies-versions]
 
-See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.
-
-
-```sh
-{{stack-version}}
-```
-
-{{stack-version}}
-
-1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-linux-x86_64.tar.gz: OK`.
-2. This directory is known as `$ES_HOME`.
+See [Elastic Stack third-party dependencies](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.

deploy-manage/deploy/self-managed/_snippets/enroll-steps.md

@@ -0,0 +1,21 @@
+If this is the first time you’re starting {{kib}}, this command generates a unique link in your terminal to enroll your {{kib}} instance with {{es}}.
+
+1. In your terminal, click the generated link to open {{kib}} in your browser.
+2. In your browser, paste the enrollment token that was generated in the terminal when you started {{es}}, and then click the button to connect your {{kib}} instance with {{es}}.
+3. Log in to {{kib}} as the `elastic` user with the password that was generated when you started {{es}}.
+
+::::{note}
+If you need to reset the password for the `elastic` user or other built-in users, run the [`elasticsearch-reset-password`](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/command-line-tools/reset-password.md) tool. To generate new enrollment tokens for {{kib}} or {{es}} nodes, run the [`elasticsearch-create-enrollment-token`](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/command-line-tools/create-enrollment-token.md) tool. These tools are available in the {{es}} `bin` directory.
+::::
+
+:::{tip}
+{{kib}} won’t enter interactive mode if it detects existing credentials for {{es}} (`elasticsearch.username` and `elasticsearch.password`) or an existing URL for `elasticsearch.hosts`.
+
+In this case, you can enroll {{kib}} in detached mode:
+
+Run the `kibana-setup` tool and pass the generated enrollment token with the `--enrollment-token` parameter.
+
+```sh
+bin/kibana-setup --enrollment-token <enrollment-token>
+```
+:::

deploy-manage/deploy/self-managed/_snippets/enroll-systemd.md

@@ -0,0 +1,30 @@
+1. Run the `status` command to get details about the {{{kib}}} service.
+
+    ```sh
+    sudo systemctl status kibana
+    ```
+
+
+    In the `status` command output, a URL is shown with:
+
+    * A host address to access {{kib}}
+    * A six digit verification code
+  
+    For example:
+
+    ```sh
+    Kibana has not been configured.
+    Go to http://<host>:5601/?code=<code> to get started.
+    ```
+
+    Make a note of the verification code.
+
+2. Go to the host address.
+
+    It can take a minute or two for {{kib}} to start up, so refresh the page if you don’t see a prompt right away.
+
+3. When {{kib}} starts, you’re prompted to provide an enrollment token. Paste in the {{kib}} enrollment token that you generated earlier.
+4. Click **Configure Elastic**.
+5. If you’re prompted to provide a verification code, copy and paste in the six digit code that was returned by the `status` command. Then, wait for the setup to complete.
+6. When you see the **Welcome to Elastic** page, provide the `elastic` as the username and provide the password that you copied from the install command output when you set up your first {{es}} node.
+7. Click **Log in**.

deploy-manage/deploy/self-managed/_snippets/install-next-steps.md

@@ -1,5 +1,4 @@
 You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, you must do some additional setup:
 
 * Learn how to [configure {{es}}](/deploy-manage/deploy/self-managed/configure-elasticsearch.md).
-* Configure [important {{es}} settings](/deploy-manage/deploy/self-managed/important-settings-configuration.md).
-* Configure [important system settings](/deploy-manage/deploy/self-managed/important-system-configuration.md).
+* Configure [important {{es}} settings](/deploy-manage/deploy/self-managed/important-settings-configuration.md).

deploy-manage/deploy/self-managed/_snippets/kib-releases.md

@@ -0,0 +1 @@
+The latest stable version of {{kib}} can be found on the [Download Kibana](https://elastic.co/downloads/kibana) page. Other versions can be found on the [Past Releases page](https://elastic.co/downloads/past-releases).

deploy-manage/deploy/self-managed/_snippets/new-enrollment-token.md

@@ -0,0 +1,5 @@
+If your enrollment token has expired, then you can generate a new enrollment token for {{kib}} with the [`elasticsearch-create-enrollment-token`](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/command-line-tools/create-enrollment-token.md) tool:
+
+```sh
+bin/elasticsearch-create-enrollment-token -s kibana
+```

deploy-manage/deploy/self-managed/access-kibana.md

@@ -0,0 +1,21 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/kibana/current/access.html
+---
+
+# Access {{kib}} [access]
+
+Access {{kib}} through the web application on port 5601.
+
+1. Point your web browser to the machine where you are running {{kib}} and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
+
+    To remotely connect to {{kib}}, set [server.host](configure.md#server-host) to a non-loopback address.
+
+2. Log on to your account.
+3. Go to the home page, then click **{{kib}}**.
+4. To make the {{kib}} page your landing page, click **Make this my landing page**.
+
+## Resources
+
+* [Troubleshoot: Check {{kib}} server status](/troubleshoot/kibana/access.md)
+* [Troubleshoot: Error: {{kib}} server is not ready yet](/troubleshoot/kibana/error-server-not-ready.md) 

deploy-manage/deploy/self-managed/access.md

@@ -1,6 +1,9 @@
 ---
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html
+applies_to:
+  deployment:
+    self:
 ---
 
 # Configure {{es}} [settings]
@@ -9,8 +12,14 @@ mapped_pages:
 
 The configuration files should contain settings which are node-specific (such as `node.name` and paths), or settings which a node requires in order to be able to join a cluster, such as `cluster.name` and `network.host`.
 
+## Available settings
 
-## Config files location [config-files-location] 
+For a complete list of settings that you can apply to your {{es}} cluster, refer to the [Elasticsearch configuration reference](elasticsearch://reference/elasticsearch/configuration-reference.md).
+
+For a list of settings that must be configured before using your cluster in production, refer to [](/deploy-manage/deploy/self-managed/important-settings-configuration.md).
+
+
+## Config files [config-files-location] 
 
 {{es}} has three configuration files:
 
@@ -20,15 +29,26 @@ The configuration files should contain settings which are node-specific (such as
 
 These files are located in the config directory, whose default location depends on whether or not the installation is from an archive distribution (`tar.gz` or `zip`) or a package distribution (Debian or RPM packages).
 
-For the archive distributions, the config directory location defaults to `$ES_HOME/config`. The location of the config directory can be changed via the `ES_PATH_CONF` environment variable as follows:
+### Archive distributions
+
+For the archive distributions, the config directory location defaults to `$ES_HOME/config`. The location of the config directory can be changed using the `ES_PATH_CONF` environment variable:
 
 ```sh
 ES_PATH_CONF=/path/to/my/config ./bin/elasticsearch
 ```
 
-Alternatively, you can `export` the `ES_PATH_CONF` environment variable via the command line or via your shell profile.
+Alternatively, you can `export` the `ES_PATH_CONF` environment variable through the command line or through your shell profile.
+
+### Package distributions
+
+For the package distributions, the config directory location defaults to `/etc/elasticsearch`. 
+
+The location of the config directory can be changed by setting the `ES_PATH_CONF` environment variable, however, setting the environment variable in your shell is not sufficient. Instead, this variable is sourced from one the following locations:
+
+* Debian: `/etc/default/elasticsearch` 
+* RPM: `/etc/sysconfig/elasticsearch` 
 
-For the package distributions, the config directory location defaults to `/etc/elasticsearch`. The location of the config directory can also be changed via the `ES_PATH_CONF` environment variable, but note that setting this in your shell is not sufficient. Instead, this variable is sourced from `/etc/default/elasticsearch` (for the Debian package) and `/etc/sysconfig/elasticsearch` (for the RPM package). You will need to edit the `ES_PATH_CONF=/etc/elasticsearch` entry in one of these files accordingly to change the config directory location.
+You need to edit the `ES_PATH_CONF=/etc/elasticsearch` entry in the relevant file for your package to change the config directory location.
 
 
 ## Config file format [_config_file_format] 
@@ -79,15 +99,13 @@ Values for environment variables must be simple strings. Use a comma-separated s
 export HOSTNAME="host1,host2"
 ```
 
-
 ## Cluster and node setting types [cluster-setting-types] 
 
 Cluster and node settings can be categorized based on how they are configured:
 
-$$$dynamic-cluster-setting$$$
+### Dynamic [dynamic-cluster-setting]
 
-Dynamic
-:   You can configure and update dynamic settings on a running cluster using the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). You can also configure dynamic settings locally on an unstarted or shut down node using `elasticsearch.yml`.
+You can configure and update dynamic settings on a running cluster using the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). You can also configure dynamic settings locally on an unstarted or shut down node using `elasticsearch.yml`.
 
 Updates made using the cluster update settings API can be *persistent*, which apply across cluster restarts, or *transient*, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a `null` value using the API.
 
@@ -100,27 +118,18 @@ If you configure the same setting using multiple methods, {{es}} applies the set
 
 For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.
 
-::::{tip} 
-If you use {{ech}}, use the [user settings](../elastic-cloud/edit-stack-settings.md) feature to configure all cluster settings. This method lets {{ech}} automatically reject unsafe settings that could break your cluster.
-
-If you run {{es}} on your own hardware, use the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.
-
-::::
-
+Use the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.
 
 ::::{warning} 
 We no longer recommend using transient cluster settings. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
-
 ::::
 
 
+### Static [static-cluster-setting]
 
-$$$static-cluster-setting$$$
-
-Static
-:   Static settings can only be configured on an unstarted or shut down node using `elasticsearch.yml`.
+Static settings can only be configured on an unstarted or shut down node using `elasticsearch.yml`.
 
-    Static settings must be set on every relevant node in the cluster.
+Static settings must be set on every relevant node in the cluster.
 
 
 

deploy-manage/deploy/self-managed/configure-elasticsearch.md

@@ -0,0 +1,29 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/kibana/current/settings.html
+---
+
+# Configure {{kib}} [settings]
+
+The {{kib}} server reads properties from the `kibana.yml` file on startup. 
+
+The location of this file differs depending on how you installed {{kib}}
+
+* **Archive distributions (`.tar.gz` or `.zip`)**: Default location is `$KIBANA_HOME/config`
+* **Package distributions (Debian or RPM)**: Default location is `/etc/kibana`
+
+The config directory can be changed using the `KBN_PATH_CONF` environment variable:
+
+```text
+KBN_PATH_CONF=/home/kibana/config ./bin/kibana
+```
+
+The default host and port settings configure {{kib}} to run on `localhost:5601`. To change this behavior and allow remote users to connect, you need to update your [`server.host`](kibana://reference/configuration-reference/general-settings.md#server-host) and [`server.port`](kibana://reference/configuration-reference/general-settings.md#server-port) settings in the `kibana.yml` file.
+
+In this file, you can also enable SSL and set a variety of other options.
+
+Environment variables can be injected into configuration using `${MY_ENV_VAR}` syntax. By default, configuration validation will fail if an environment variable used in the config file is not present when {{kib}} starts. This behavior can be changed by using a default value for the environment variable, using the `${MY_ENV_VAR:defaultValue}` syntax.
+
+## Available settings
+
+For a complete list of settings that you can apply to {{kib}}, refer to [{{kib}} configuration reference](kibana:///reference/configuration-reference.md).