New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for mira 2.0 #477

Merged
merged 4 commits into from Feb 1, 2019

Conversation

Projects
None yet
4 participants
@FredrikFolkesson
Copy link
Member

FredrikFolkesson commented Jan 30, 2019

Changes in the documentation about having to specify the root user when running mira in local or swarm mode.

We will also need to update information about mira being able to only check for engines in a specified namespace, which is something Louis is working on.

FredrikFolkesson added some commits Jan 30, 2019

@qlikossbuild

This comment has been minimized.

Copy link
Contributor

qlikossbuild commented Jan 30, 2019

Deploy preview for core-website ready!

Built with commit 61aa93c

https://deploy-preview-477--core-website.netlify.com

@@ -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.

@wennmo

wennmo Jan 31, 2019

Member

Maybe we should also add a comment to why the default user is non-root?

@FredrikFolkesson FredrikFolkesson changed the title [WIP] Update docs for mira 2.0 Update docs for mira 2.0 Feb 1, 2019

@peol

peol approved these changes Feb 1, 2019

Copy link
Member

peol left a comment

Nice, good work. Some minor comments.


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.

@peol

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.

@peol

peol Feb 1, 2019

Member

Missing period (.)

@@ -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.

@peol

peol Feb 1, 2019

Member

Mira

This comment has been minimized.

@peol

peol Feb 1, 2019

Member

Missing period (.)

@wennmo

wennmo approved these changes Feb 1, 2019

Copy link
Member

wennmo left a comment

LGTM, just a minor comment

@@ -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.

@wennmo

wennmo Feb 1, 2019

Member

only applicable in one mode? 😉

@FredrikFolkesson FredrikFolkesson merged commit 9102af7 into master Feb 1, 2019

3 checks passed

ci/circleci Your tests passed on CircleCI!
Details
cla/verification CLA OK
deploy/netlify Deploy preview ready!
Details

@FredrikFolkesson 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