Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upUpdate docs for mira 2.0 #477
Conversation
FredrikFolkesson
added some commits
Jan 30, 2019
This comment has been minimized.
This comment has been minimized.
|
Deploy preview for core-website ready! Built with commit 61aa93c |
wennmo
reviewed
Jan 31, 2019
docs/services/mira.md
Outdated
| @@ -53,6 +53,7 @@ Mira supports the following operation modes: | |||
| |[Local](#local-mode) | Discovers Qlik Associative Engine instances running on the local Docker Engine. | | |||
|
|
|||
| To set the operation mode, define the environment variable `MIRA_MODE` on the Mira container. | |||
| In `Local` or `Swarm` mode you will also have to set the running user to `root` in your `docker-compose.yml` file | |||
This comment has been minimized.
This comment has been minimized.
FredrikFolkesson
changed the title
[WIP] Update docs for mira 2.0
Update docs for mira 2.0
Feb 1, 2019
docs/services/mira.md
Outdated
|
|
||
| To set the operation mode, define the environment variable `MIRA_MODE` on the Mira container. | ||
| In `Local` or `Swarm` mode you will also have to set the running user to `root` in your `docker-compose.yml` file. |
This comment has been minimized.
This comment has been minimized.
peol
Feb 1, 2019
Member
Usually when you do backticks, it refers to the actual code value you use (e.g. local or swarm)
| @@ -103,7 +106,8 @@ In _Swarm_ mode Mira communicates with Docker Remote API to discover Qlik Associ | |||
| How Mira should access the Docker Remote API can be configured in two ways. | |||
|
|
|||
| Mount `docker.sock` as a volume into the Mira container as shown in this [example](https://github.com/qlik-oss/mira/blob/master/docker-compose.yml). | |||
| It is however only possible to mount `docker.sock` on a Swarm manager node. | |||
| It is however only possible to mount `docker.sock` on a Swarm manager node. To be able to mount the local `docker.sock` | |||
This comment has been minimized.
This comment has been minimized.
docs/services/mira.md
Outdated
| @@ -359,6 +366,7 @@ that are running on the `localhost` Docker Engine, without any orchestration pla | |||
|
|
|||
| You can enable _Local_ mode by setting the `MIRA_MODE` environment variable to `local` | |||
| before you start the Mira Docker container. | |||
| You also need to set mira to run as the `root` user in your `docker-compose.yml` file | |||
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
docs/services/mira.md
Outdated
| @@ -32,8 +32,9 @@ The following environment variables can optionally be set: | |||
| | MIRA_DISCOVERY_HOSTNAME | n/a | Hostname that Mira uses to query DNS for Qlik Associative Engine instances.<br>- Applicable in mode `dns`. | | |||
| | MIRA_ENGINE_API_PORT_LABEL | qix-engine-api-port | Label that Mira uses to determine the QIX API (websocket) port.<br/>- Applicable in modes `swarm`, `kubernetes`, and `local`. | | |||
| | MIRA_ENGINE_METRICS_PORT_LABEL | qix-engine-metrics-port | Label that Mira uses to determine the `/metrics` port.<br/>- Applicable in modes `swarm`, `kubernetes`, and `local`. | | |||
| | MIRA_ENGINE_DISCOVERY_INTERVAL | 10000 | Interval in milliseconds for discovering Qlik Associative Engine instances. | | |||
| | MIRA_ENGINE_UPDATE_INTERVAL | 10000 | Interval in milliseconds for updating health and metrics for Qlik Associative Engine instances. | | |||
| | MIRA_KUBERNETES_TARGET_NAMESPACE | n/a | Namespace that Mira looks for Qlik Associative Engines in. If not set Mira will look into all namespaces. <br/>- Applicable in modes `kubernetes`. | | |||
This comment has been minimized.
This comment has been minimized.
FredrikFolkesson
merged commit 9102af7
into
master
Feb 1, 2019
FredrikFolkesson
deleted the
update-docs-for-mira-2.0
branch
Feb 1, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
FredrikFolkesson commentedJan 30, 2019
Changes in the documentation about having to specify the root user when running
mirainlocalorswarmmode.We will also need to update information about
mirabeing able to only check for engines in a specified namespace, which is something Louis is working on.