Docker Library Bot 7 lat temu
rodzic
commit
47d0e8d208
1 zmienionych plików z 35 dodań i 17 usunięć
  1. 35 17
      percona/README.md

+ 35 - 17
percona/README.md

@@ -16,9 +16,9 @@ WARNING:
 
 # Supported tags and respective `Dockerfile` links
 
--	[`5.7.23-stretch`, `5.7-stretch`, `5-stretch`, `stretch`, `5.7.23`, `5.7`, `5`, `latest` (*5.7/Dockerfile*)](https://github.com/docker-library/percona/blob/3cc4caa4d34bf744283d48af4b11f19e28217e3f/5.7/Dockerfile)
--	[`5.6.41-stretch`, `5.6-stretch`, `5.6.41`, `5.6` (*5.6/Dockerfile*)](https://github.com/docker-library/percona/blob/c21319e084e50e831f33767d8ee1110711f93472/5.6/Dockerfile)
--	[`5.5.61-stretch`, `5.5-stretch`, `5.5.61`, `5.5` (*5.5/Dockerfile*)](https://github.com/docker-library/percona/blob/c21319e084e50e831f33767d8ee1110711f93472/5.5/Dockerfile)
+-	[`8.0.12-2rc1-centos`, `8.0-centos`, `8-centos`, `8.0.12-2rc1`, `8.0`, `8` (*percona-server.80/Dockerfile*)](https://github.com/percona/percona-docker/blob/9f4a229bf338497d47b7216929a53f715fdade17/percona-server.80/Dockerfile)
+-	[`5.7.23-centos`, `5.7-centos`, `5-centos`, `centos`, `5.7.23`, `5.7`, `5`, `latest` (*percona-server.57/Dockerfile-dockerhub*)](https://github.com/percona/percona-docker/blob/9f4a229bf338497d47b7216929a53f715fdade17/percona-server.57/Dockerfile-dockerhub)
+-	[`5.6.41-centos`, `5.6-centos`, `5.6.41`, `5.6` (*percona-server.56/Dockerfile-dockerhub*)](https://github.com/percona/percona-docker/blob/9f4a229bf338497d47b7216929a53f715fdade17/percona-server.56/Dockerfile-dockerhub)
 
 # Quick reference
 
@@ -26,10 +26,10 @@ WARNING:
 	[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
 
 -	**Where to file issues**:  
-	[https://github.com/docker-library/percona/issues](https://github.com/docker-library/percona/issues)
+	[https://github.com/percona/percona-docker/issues](https://github.com/percona/percona-docker/issues)
 
 -	**Maintained by**:  
-	[the Docker Community](https://github.com/docker-library/percona)
+	[Percona](https://github.com/percona/percona-docker)
 
 -	**Supported architectures**: ([more info](https://github.com/docker-library/official-images#architectures-other-than-amd64))  
 	[`amd64`](https://hub.docker.com/r/amd64/percona/)
@@ -48,9 +48,9 @@ WARNING:
 -	**Supported Docker versions**:  
 	[the latest release](https://github.com/docker/docker-ce/releases/latest) (down to 1.6 on a best-effort basis)
 
-# Percona Server
+# Percona Server for MySQL
 
-Percona Server is a fork of the MySQL relational database management system created by Percona.
+Percona Server for MySQL is a fork of the MySQL relational database management system created by Percona.
 
 It aims to retain close compatibility to the official MySQL releases, while focusing on performance and increased visibility into server operations. Also included in Percona Server is XtraDB, Percona's fork of the InnoDB Storage Engine.
 
@@ -62,7 +62,7 @@ It aims to retain close compatibility to the official MySQL releases, while focu
 
 ## Start a `percona` server instance
 
-Starting a Percona instance is simple:
+Starting a Percona Server for MySQL instance is simple:
 
 ```console
 $ docker run --name some-percona -e MYSQL_ROOT_PASSWORD=my-secret-pw -d percona:tag
@@ -72,7 +72,7 @@ $ docker run --name some-percona -e MYSQL_ROOT_PASSWORD=my-secret-pw -d percona:
 
 ## Connect to MySQL from an application in another Docker container
 
-Since Percona is intended as a drop-in replacement for MySQL, it can be used with many applications.
+Since Percona Server for MySQL is intended as a drop-in replacement for MySQL, it can be used with many applications.
 
 This image exposes the standard MySQL port (3306), so container linking makes the MySQL instance available to other application containers. Start your application container like this in order to link it to the MySQL container:
 
@@ -80,7 +80,7 @@ This image exposes the standard MySQL port (3306), so container linking makes th
 $ docker run --name some-app --link some-percona:mysql -d application-that-uses-mysql
 ```
 
-## Connect to Percona from the MySQL command line client
+## Connect to Percona Server for MySQL from the command line client
 
 The following command starts another `percona` container instance and runs the `mysql` command line client against your original `percona` container, allowing you to execute SQL statements against your database instance:
 
@@ -90,7 +90,7 @@ $ docker run -it --link some-percona:mysql --rm percona sh -c 'exec mysql -h"$MY
 
 ... where `some-percona` is the name of your original `percona` container.
 
-This image can also be used as a client for non-Docker or remote Percona instances:
+This image can also be used as a client for non-Docker or remote instances:
 
 ```console
 $ docker run -it --rm percona mysql -hsome.mysql.host -usome-mysql-user -p
@@ -133,7 +133,7 @@ The `docker exec` command allows you to run commands inside a Docker container.
 $ docker exec -it some-percona bash
 ```
 
-The Percona Server log is available through Docker's container log:
+The log is available through Docker's container log:
 
 ```console
 $ docker logs some-percona
@@ -141,7 +141,7 @@ $ docker logs some-percona
 
 ## Using a custom MySQL configuration file
 
-The Percona startup configuration is specified in the file `/etc/mysql/my.cnf`, and that file in turn includes any files found in the `/etc/mysql/conf.d` directory that end with `.cnf`. Settings in files in this directory will augment and/or override settings in `/etc/mysql/my.cnf`. If you want to use a customized MySQL configuration, you can create your alternative configuration file in a directory on the host machine and then mount that directory location as `/etc/mysql/conf.d` inside the `percona` container.
+The startup configuration is specified in the file `/etc/my.cnf`, and that file in turn includes any files found in the `/etc/my.cnf.d` directory that end with `.cnf`. Settings in files in this directory will augment and/or override settings in `/etc/my.cnf`. If you want to use a customized MySQL configuration, you can create your alternative configuration file in a directory on the host machine and then mount that directory location as `/etc/my.cnf.d` inside the `percona` container.
 
 If `/my/custom/config-file.cnf` is the path and name of your custom configuration file, you can start your `percona` container like this (note that only the directory path of the custom config file is used in this command):
 
@@ -149,7 +149,7 @@ If `/my/custom/config-file.cnf` is the path and name of your custom configuratio
 $ docker run --name some-percona -v /my/custom:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORD=my-secret-pw -d percona:tag
 ```
 
-This will start a new container `some-percona` where the Percona instance uses the combined startup settings from `/etc/mysql/my.cnf` and `/etc/mysql/conf.d/config-file.cnf`, with settings from the latter taking precedence.
+This will start a new container `some-percona` where the Percona Server for MySQL instance uses the combined startup settings from `/etc/my.cnf` and `/etc/my.cnf.d/config-file.cnf`, with settings from the latter taking precedence.
 
 ### Configuration without a `cnf` file
 
@@ -167,11 +167,15 @@ $ docker run -it --rm percona:tag --verbose --help
 
 ## Environment Variables
 
-When you start the `percona` image, you can adjust the configuration of the Percona instance by passing one or more environment variables on the `docker run` command line. Do note that none of the variables below will have any effect if you start the container with a data directory that already contains a database: any pre-existing database will always be left untouched on container startup.
+When you start the `percona` image, you can adjust the configuration of the instance by passing one or more environment variables on the `docker run` command line. Do note that none of the variables below will have any effect if you start the container with a data directory that already contains a database: any pre-existing database will always be left untouched on container startup.
 
 ### `MYSQL_ROOT_PASSWORD`
 
-This variable is mandatory and specifies the password that will be set for the Percona `root` superuser account. In the above example, it was set to `my-secret-pw`.
+This variable is mandatory and specifies the password that will be set for the `root` superuser account. In the above example, it was set to `my-secret-pw`.
+
+### `MYSQL_ROOT_HOST`
+
+By default, `root` can connect from anywhere. This option restricts root connections to be from the specified host only. Also `localhost` can be used here for the local-only root access.
 
 ### `MYSQL_DATABASE`
 
@@ -185,7 +189,7 @@ Do note that there is no need to use this mechanism to create the root superuser
 
 ### `MYSQL_ALLOW_EMPTY_PASSWORD`
 
-This is an optional variable. Set to `yes` to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your Percona instance completely unprotected, allowing anyone to gain complete superuser access.
+This is an optional variable. Set to `yes` to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your instance completely unprotected, allowing anyone to gain complete superuser access.
 
 ### `MYSQL_RANDOM_ROOT_PASSWORD`
 
@@ -195,6 +199,18 @@ This is an optional variable. Set to `yes` to generate a random initial password
 
 Sets root (*not* the user specified in `MYSQL_USER`!) user as expired once init is complete, forcing a password change on first login. *NOTE*: This feature is supported on MySQL 5.6+ only. Using this option on MySQL 5.5 will throw an appropriate error during initialization.
 
+### `MYSQL_INITDB_SKIP_TZINFO`
+
+At first run MySQL automatically loads from the local system the timezone information needed for the `CONVERT_TZ()` function. If it's is not what is intended, this option disables timezone loading.
+
+### `INIT_TOKUDB`
+
+Tuns on TokuDB Engine. It can be activated only when *transparent huge pages* (THP) are disabled.
+
+### `INIT_ROCKSDB`
+
+Tuns on RocksDB Engine.
+
 ## Docker Secrets
 
 As an alternative to passing sensitive information via environment variables, `_FILE` may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in `/run/secrets/<secret_name>` files. For example:
@@ -233,6 +249,8 @@ The `-v /my/own/datadir:/var/lib/mysql` part of the command mounts the `/my/own/
 
 If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as `docker-compose`, which start several containers simultaneously.
 
+If the application you're trying to connect to MySQL does not handle MySQL downtime or waiting for MySQL to start gracefully, then a putting a connect-retry loop before the service starts might be necessary. For an example of such an implementation in the official images, see [WordPress](https://github.com/docker-library/wordpress/blob/1b48b4bccd7adb0f7ea1431c7b470a40e186f3da/docker-entrypoint.sh#L195-L235) or [Bonita](https://github.com/docker-library/docs/blob/9660a0cccb87d8db842f33bc0578d769caaf3ba9/bonita/stack.yml#L28-L44).
+
 ## Usage against an existing database
 
 If you start your `percona` container instance with a data directory that already contains a database (specifically, a `mysql` subdirectory), the `$MYSQL_ROOT_PASSWORD` variable should be omitted from the run command line; it will in any case be ignored, and the pre-existing database will not be changed in any way.