Skip to content

Commit

Permalink
doc: Convert deprecated Alerts syntax markers
Browse files Browse the repository at this point in the history
  • Loading branch information
antoineco committed Oct 17, 2023
1 parent 1cbbdf2 commit 39510e0
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Other available stack variants:
and Fleet
* [`searchguard`](https://github.com/deviantony/docker-elk/tree/searchguard): Search Guard support

> **Note**
> [!IMPORTANT]
> [Platinum][subscriptions] features are enabled by default for a [trial][license-mngmt] duration of **30 days**. After
> this evaluation period, you will retain access to all the free features included in the Open Basic license seamlessly,
> without manual intervention required, and without losing any data. Refer to the [How to disable paid
Expand Down Expand Up @@ -94,7 +94,7 @@ own_. [sherifabdlnaby/elastdocker][elastdocker] is one example among others of p
* [Docker Compose][compose-install] version **1.28.0** or newer (including [Compose V2][compose-v2])
* 1.5 GB of RAM

> **Note**
> [!NOTE]
> Especially on Linux, make sure your user has the [required permissions][linux-postinstall] to interact with the Docker
> daemon.
Expand All @@ -107,7 +107,7 @@ By default, the stack exposes the following ports:
* 9300: Elasticsearch TCP transport
* 5601: Kibana

> **Warning**
> [!WARNING]
> Elasticsearch's [bootstrap checks][bootstrap-checks] were purposely disabled to facilitate the setup of the Elastic
> stack in development environments. For production setups, we recommend users to set up their host according to the
> instructions from the Elasticsearch documentation: [Important System Configuration][es-sys-config].
Expand All @@ -127,7 +127,7 @@ instructions from the [documentation][mac-filesharing] to add more locations.

## Usage

> **Warning**
> [!WARNING]
> You must rebuild the stack images with `docker-compose build` whenever you switch branch or update the
> [version](#version-selection) of an already existing stack.
Expand All @@ -151,7 +151,7 @@ If everything went well and the setup completed without error, start the other s
docker-compose up
```

> **Note**
> [!NOTE]
> You can also run all services in the background (detached mode) by appending the `-d` flag to the above command.
Give Kibana about a minute to initialize, then access the Kibana web UI by opening <http://localhost:5601> in a web
Expand All @@ -160,7 +160,7 @@ browser and use the following (default) credentials to log in:
* user: *elastic*
* password: *changeme*

> **Note**
> [!NOTE]
> Upon the initial startup, the `elastic`, `logstash_internal` and `kibana_system` Elasticsearch users are intialized
> with the values of the passwords defined in the [`.env`](.env) file (_"changeme"_ by default). The first one is the
> [built-in superuser][builtin-users], the other two are used by Kibana and Logstash respectively to communicate with
Expand All @@ -171,10 +171,10 @@ browser and use the following (default) credentials to log in:

#### Setting up user authentication

> **Note**
> [!NOTE]
> Refer to [Security settings in Elasticsearch][es-security] to disable authentication.
> **Warning**
> [!WARNING]
> Starting with Elastic v8.0.0, it is no longer possible to run Kibana using the bootstraped privileged `elastic` user.
The _"changeme"_ password set by default for all aforementioned users is **unsecure**. For increased security, we will
Expand Down Expand Up @@ -207,7 +207,7 @@ reset the passwords of all aforementioned Elasticsearch users to random secrets.
Its value isn't used by any core component, but [extensions](#how-to-enable-the-provided-extensions) use it to
connect to Elasticsearch.
> **Note**
> [!NOTE]
> In case you don't plan on using any of the provided [extensions](#how-to-enable-the-provided-extensions), or
> prefer to create your own roles and users to authenticate these services, it is safe to remove the
> `ELASTIC_PASSWORD` entry from the `.env` file altogether after the stack has been initialized.
Expand All @@ -226,7 +226,7 @@ reset the passwords of all aforementioned Elasticsearch users to random secrets.
docker-compose up -d logstash kibana
```

> **Note**
> [!NOTE]
> Learn more about the security of the Elastic stack at [Secure the Elastic Stack][sec-cluster].

#### Injecting data
Expand Down Expand Up @@ -272,7 +272,7 @@ To use a different version of the core Elastic components, simply change the ver
file. If you are upgrading an existing stack, remember to rebuild all container images using the `docker-compose build`
command.

> **Warning**
> [!IMPORTANT]
> Always pay attention to the [official upgrade instructions][upgrade] for each individual component before performing a
> stack upgrade.

Expand All @@ -284,7 +284,7 @@ Older major versions are also supported on separate branches:

## Configuration

> **Note**
> [!IMPORTANT]
> Configuration is not dynamically reloaded, you will need to restart individual components after any configuration
> change.

Expand Down
4 changes: 2 additions & 2 deletions extensions/enterprise-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ secret_management.encryption_keys:
secret_management.encryption_keys: [my_first_encryption_key, my_second_encryption_key, ...]
```
> **Note**
> [!NOTE]
> To generate a strong random encryption key, you can use the OpenSSL utility or any other online/offline tool of your
> choice:
>
Expand Down Expand Up @@ -96,7 +96,7 @@ enterprise-search:
ENT_SEARCH_DEFAULT_PASSWORD: {{some strong password}}
```

> **Warning**
> [!WARNING]
> The default Enterprise Search password can only be set during the initial boot. Once the password is persisted in
> Elasticsearch, it can only be changed via the Elasticsearch API.

Expand Down
2 changes: 1 addition & 1 deletion extensions/fleet/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fleet Server

> **Warning**
> [!WARNING]
> This extension currently exists for preview purposes and should be considered **EXPERIMENTAL**. Expect regular changes
> to the default Fleet settings, both in the Elastic Agent and Kibana.
>
Expand Down

0 comments on commit 39510e0

Please sign in to comment.