Skip to content

Commit

Permalink
Merge pull request percona#134 from borys-belinsky/doc/update/1.8.0a
Browse files Browse the repository at this point in the history
Doc/update/1.8.0a
  • Loading branch information
borys-belinsky authored Feb 19, 2018
2 parents 59a271e + 45e80cf commit 198e6a5
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 31 deletions.
4 changes: 2 additions & 2 deletions doc/source/.res/code/sh.org
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ SSL related options removed
--volumes-from pmm-data \
--name pmm-server \
-e SERVER_USER=jsmith \
-e SERVER_PASSWORD=pass1234 \
-e SERVER_PASSWORD=SomeR4ndom-Pa$$w0rd \
-v /etc/pmm-certs:/etc/nginx/ssl \
--restart always \
percona/pmm-server:latest
Expand Down Expand Up @@ -446,7 +446,7 @@ SSL related options removed
--volumes-from pmm-data \
--name pmm-server \
-e SERVER_USER=jsmith \
-e SERVER_PASSWORD=pass1234 \
-e SERVER_PASSWORD=SomeR4ndom-Pa$$w0rd \
--restart always \
percona/pmm-server:latest

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
* Ubuntu 14.04 LTS (Trusty Tahr)
* Ubuntu 16.04 LTS (Xenial Xerus)
* Ubuntu 16.10 (Yakkety Yak)
* Ubuntu 17.04 (Zesty Zapus)
* Ubuntu 17.10 (Artful Aardvark)
5 changes: 5 additions & 0 deletions doc/source/.res/replace/name.txt
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,8 @@
.. |db.admin| replace:: :file:`admin`
.. |db.local| replace:: :file:`local`

.. Metrics
.. |mysql-global-status-commands-total| replace:: :command:`mysql_global_status_commands_total`
.. |mysql-global-variables-autocommit| replace:: :command:`mysql_global_variables_autocommit`
12 changes: 11 additions & 1 deletion doc/source/exporter-option.mysqld.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
|mysql| Server Exporter (mysqld_exporter)
================================================================================

|mysqld_exporter| is the |prometheus| exporter for |mysql|
metrics. This exporter has three resolutions to group the metrics:

- metrics-lr (metrics with a low resolution)
- metrics-mr (metrics with a medium resolution)
- metrics-hr (metrics with a high resolution)

For example, *metrics-hr* contains very frequently changing values, such as |mysql-global-status-commands-total|.
On the other hand, *metrics-lr* contains infrequently changing values such as |mysql-global-variables-autocommit|.

The following options may be passed to the |opt.mysql-metrics| monitoring
service as additional options.

Expand Down Expand Up @@ -34,4 +44,4 @@ General options

.. include:: .res/replace/option.txt
.. include:: .res/replace/name.txt

.. include:: .res/replace/program.txt
57 changes: 30 additions & 27 deletions doc/source/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,10 @@ Security Features in |pmm.name|
You can protect |pmm| from unauthorized access using the following security
features:

- HTTP password protection adds authentication
when accessing the |pmm-server| web interface
- SSL encryption secures traffic between |pmm-client| and |pmm-server|
- HTTP password protection adds authentication when accessing the |pmm-server|
web interface

Enabling Password Protection
================================================================================

You can set the password for accessing the |pmm-server| web interface by passing
the :term:`SERVER_PASSWORD <SERVER_PASSWORD (Option)>` environment variable when
:ref:`creating and running the PMM Server container <server-container>`.

To set the environment variable, use the ``-e`` option.

By default, the user name is ``pmm``. You can change it by passing the
:term:`SERVER_USER <SERVER_USER (Option)>` environment variable. For example:

|tip.run-all.root|.

.. include:: .res/code/sh.org
:start-after: +docker.run.server-user.example+
:end-before: #+end-block

|pmm-client| uses the same credentials to communicate with |pmm-server|.
If you set the user name and password as described,
specify them when :ref:`connect-client`:

.. include:: .res/code/sh.org
:start-after: +pmm-admin.config.server.server-user.server-password+
:end-before: #+end-block

Enabling SSL Encryption
================================================================================
Expand Down Expand Up @@ -102,6 +77,34 @@ If you generated a self-signed certificate:
.. include:: .res/code/sh.org
:start-after: +pmm-admin.config.server.server-insecure-ssl+
:end-before: #+end-block

Enabling Password Protection
================================================================================

You can set the password for accessing the |pmm-server| web interface by passing
the :term:`SERVER_PASSWORD <SERVER_PASSWORD (Option)>` environment variable when
:ref:`creating and running the PMM Server container <server-container>`.

To set the environment variable, use the ``-e`` option.

By default, the user name is ``pmm``. You can change it by passing the
:term:`SERVER_USER <SERVER_USER (Option)>` environment variable. Note that the
following example uses an insecure port 80 which is typically used for HTTP
connections.

|tip.run-all.root|.

.. include:: .res/code/sh.org
:start-after: +docker.run.server-user.example+
:end-before: #+end-block

|pmm-client| uses the same credentials to communicate with |pmm-server|. If you
set the user name and password as described, specify them when
:ref:`connect-client`:

.. include:: .res/code/sh.org
:start-after: +pmm-admin.config.server.server-user.server-password+
:end-before: #+end-block

Combining Security Features
================================================================================
Expand Down

0 comments on commit 198e6a5

Please sign in to comment.