From c9ca5d5f985ca58086bc01841043bf67d2c8c29f Mon Sep 17 00:00:00 2001 From: Markus Makela Date: Mon, 23 Mar 2015 20:12:56 +0200 Subject: [PATCH] Changed install path to /usr/local/mariadb-maxscale --- About/SETUP.md | 6 +++--- Changelog.md | 2 +- Getting-Started/Building-MaxScale-from-Source-Code.md | 2 +- Getting-Started/Configuration-Guide.md | 2 +- Getting-Started/Getting-Started-With-MaxScale.md | 2 +- Release-Notes/MaxScale-1.1-Release-Notes.md | 2 +- Tutorials/Administration-Tutorial.md | 10 +++++----- .../Galera-Cluster-Connection-Routing-Tutorial.md | 6 +++--- .../Galera-Cluster-Read-Write-Splitting-Tutorial.md | 6 +++--- Tutorials/MySQL-Cluster-Setup.md | 2 +- .../MySQL-Replication-Connection-Routing-Tutorial.md | 4 ++-- .../MySQL-Replication-Read-Write-Splitting-Tutorial.md | 6 +++--- Tutorials/Nagios-Plugins.md | 4 ++-- Tutorials/Simple-Sharding-Tutorial.md | 2 +- Upgrading-To-MaxScale-1.1.0.md | 6 +++--- 15 files changed, 31 insertions(+), 31 deletions(-) diff --git a/About/SETUP.md b/About/SETUP.md index b5c211f1f..d391b68fd 100644 --- a/About/SETUP.md +++ b/About/SETUP.md @@ -8,18 +8,18 @@ in the README file and execute make install. Simply set the environment variable MAXSCALE_HOME to point to the MaxScale directory, found inside the path into which the files have been copied, -e.g. MAXSCALE_HOME=/usr/local/mariadb/maxscale +e.g. MAXSCALE_HOME=/usr/local/mariadb-maxscale Also you will need to optionaly set LD_LIBRARY_PATH to include the 'lib' folder, found inside the path into which the files have been copied, -e.g. LD_LIBRARY_PATH=/usr/local/mariadb/maxscale/lib +e.g. LD_LIBRARY_PATH=/usr/local/mariadb-maxscale/lib Because we need the libmysqld library for parsing we must create a valid my.cnf file to enable the library to be used. Copy the my.cnf to $MAXSCALE_HOME/mysql/my.cnf. To start MaxScale execute the command 'maxscale' from the bin folder, -e.g. /usr/local/mariadb/maxscale/bin/maxscale +e.g. /usr/local/mariadb-maxscale/bin/maxscale Configuration diff --git a/Changelog.md b/Changelog.md index a4fd0d2f3..eb4f17395 100644 --- a/Changelog.md +++ b/Changelog.md @@ -2,7 +2,7 @@ These are the changes introduced in the next MaxScale version. This is not the official change log and the latest changelog can always be found in here: [MaxScale 1.1 Release Notes](Release-Notes/MaxScale-1.1-Release-Notes.md) -**NOTE:** MaxScale default installation directory has changed to `/usr/local/mariadb/maxscale` and the default password for MaxAdmin is now ´mariadb´. +**NOTE:** MaxScale default installation directory has changed to `/usr/local/mariadb-maxscale` and the default password for MaxAdmin is now ´mariadb´. * New modules added * Binlog router diff --git a/Getting-Started/Building-MaxScale-from-Source-Code.md b/Getting-Started/Building-MaxScale-from-Source-Code.md index 831e12a70..f95d2de9a 100644 --- a/Getting-Started/Building-MaxScale-from-Source-Code.md +++ b/Getting-Started/Building-MaxScale-from-Source-Code.md @@ -171,7 +171,7 @@ After the completion of the make process the installation can be achieved by run This will result in an installation being created which is identical to that which would be achieved by installing the binary package. The only difference is that init.d scripts aren't installed and the RabbitMQ components are not built. -By default, MaxScale installs to '/usr/local/mariadb/maxscale' and places init.d scripts and ldconfig files into their folders. Change the CMAKE_INSTALL_PREFIX variable to your desired installation directory and set INSTALL_SYSTEM_FILES=N to prevent the init.d script and ldconfig file installation. +By default, MaxScale installs to '/usr/local/mariadb-maxscale' and places init.d scripts and ldconfig files into their folders. Change the CMAKE_INSTALL_PREFIX variable to your desired installation directory and set INSTALL_SYSTEM_FILES=N to prevent the init.d script and ldconfig file installation. Other useful targets for Make are `documentation`, which generates the Doxygen documentation, and `uninstall` which uninstall MaxScale binaries after an install. diff --git a/Getting-Started/Configuration-Guide.md b/Getting-Started/Configuration-Guide.md index 84c48c46b..350b943a0 100644 --- a/Getting-Started/Configuration-Guide.md +++ b/Getting-Started/Configuration-Guide.md @@ -513,7 +513,7 @@ Default value is `2`. Write Timeout is the timeout in seconds for each attempt t ## Protocol Modules -The protocols supported by MaxScale are implemented as external modules that are loaded dynamically into the MaxScale core. These modules reside in the directory `$MAXSCALE_HOME/modules`, if the environment variable `$MAXSCALE_HOME` is not set it defaults to `/usr/local/mariadb/MaxScale`. It may also be set by passing the `-c` option on the MaxScale command line. +The protocols supported by MaxScale are implemented as external modules that are loaded dynamically into the MaxScale core. These modules reside in the directory `$MAXSCALE_HOME/modules`, if the environment variable `$MAXSCALE_HOME` is not set it defaults to `/usr/local/mariadb-maxscale`. It may also be set by passing the `-c` option on the MaxScale command line. ### MySQLClient diff --git a/Getting-Started/Getting-Started-With-MaxScale.md b/Getting-Started/Getting-Started-With-MaxScale.md index 789408987..9e1b3d5f8 100644 --- a/Getting-Started/Getting-Started-With-MaxScale.md +++ b/Getting-Started/Getting-Started-With-MaxScale.md @@ -65,7 +65,7 @@ modules it will search using a predescribed search path. The rules are: 1. Look in the current directory for the module 2. Look in $MAXSCALE_HOME/modules - 3. Look in /usr/local/mariadb/maxscale/modules + 3. Look in /usr/local/mariadb-maxscale/modules Configuration is read by default from the file $MAXSCALE_HOME/etc/MaxScale.cnf, /etc/MaxScale.cnf. An example file is included in in the installation and can be found in the etc/ folder within the MaxScale installation. The default value of MAXSCALE_HOME can be overriden by using the -c flag on the command line. This should be immediately followed by the path to the MaxScale home directory. The -f flag can be used on the command line to set the name and the location of the configuration file. Without path expression the file is read from \$MAXSCALE_HOME/etc directory. diff --git a/Release-Notes/MaxScale-1.1-Release-Notes.md b/Release-Notes/MaxScale-1.1-Release-Notes.md index 54b3a8cd1..fed31ead7 100644 --- a/Release-Notes/MaxScale-1.1-Release-Notes.md +++ b/Release-Notes/MaxScale-1.1-Release-Notes.md @@ -80,7 +80,7 @@ A number of bug fixes have been applied between the 1.0.5 GA and this RC release 709 - "COPYRIGHT LICENSE README SETUP" files go to /usr/local/mariadb/maxscale/ after 'make package' + "COPYRIGHT LICENSE README SETUP" files go to /usr/local/mariadb-maxscale/ after 'make package' 704 diff --git a/Tutorials/Administration-Tutorial.md b/Tutorials/Administration-Tutorial.md index 39c3833da..d212b2e17 100644 --- a/Tutorials/Administration-Tutorial.md +++ b/Tutorials/Administration-Tutorial.md @@ -22,7 +22,7 @@ or $ /etc/init.d/maxscale start -It is also possible to start MaxScale by executing the maxscale command itself, in this case you must ensure that the environment is correctly setup or command line options are passed. The major elements to consider are the correct setting of the MAXSCALE\_HOME directory and to ensure that LD\_LIBRARY\_PATH. The LD\_LIBRARY\_PATH should include the lib directory that was installed as part of the MaxScale installation, the MAXSCALE\_HOME should point to /usr/local/mariadb/maxscale if a default installation has been created or to the directory this was relocated to. Running the executable $MAXSCALE\_HOME/bin/maxscale will result in MaxScale running as a daemon process, unattached to the terminal in which it was started and using configuration files that it finds in the $MAXSCALE\_HOME directory. +It is also possible to start MaxScale by executing the maxscale command itself, in this case you must ensure that the environment is correctly setup or command line options are passed. The major elements to consider are the correct setting of the MAXSCALE\_HOME directory and to ensure that LD\_LIBRARY\_PATH. The LD\_LIBRARY\_PATH should include the lib directory that was installed as part of the MaxScale installation, the MAXSCALE\_HOME should point to /usr/local/mariadb-maxscale if a default installation has been created or to the directory this was relocated to. Running the executable $MAXSCALE\_HOME/bin/maxscale will result in MaxScale running as a daemon process, unattached to the terminal in which it was started and using configuration files that it finds in the $MAXSCALE\_HOME directory. Options may be passed to the MaxScale binary that alter this default behaviour, this options are documented in the table below. @@ -154,7 +154,7 @@ This may be integrated into the Linux logrotate mechanism by adding a configurat - @@ -175,14 +175,14 @@ One disadvantage with this is that the password used for the maxadmin command ha
/usr/local/mariadb/maxscale/log/*.log { + /usr/local/mariadb-maxscale/log/*.log { monthly rotate 5 missingok @@ -163,7 +163,7 @@ sharedscripts postrotate \# run if maxscale is running if test -n "`ps acx|grep maxscale`"; then -/usr/local/mariadb/maxscale/bin/maxadmin -pmariadb flush logs +/usr/local/mariadb-maxscale/bin/maxadmin -pmariadb flush logs fi endscript }
- diff --git a/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md b/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md index 516862542..f26bf8bab 100644 --- a/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md +++ b/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md @@ -60,7 +60,7 @@ If you wish to use two different usernames for the two different roles of monito ### Creating Your MaxScale Configuration -MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb/maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. +MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb-maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. A global, maxscale, section is included within every MaxScale configuration file; this is used to set the values of various MaxScale wide parameters, perhaps the most important of these is the number of threads that MaxScale will use to execute the code that forwards requests and handles responses for clients. @@ -89,7 +89,7 @@ In order to instruct the router to which servers it should route we must add rou The final step in the service section is to add the username and password that will be used to populate the user data from the database cluster. There are two options for representing the password, either plain text or encrypted passwords may be used. In order to use encrypted passwords a set of keys must be generated that will be used by the encryption and decryption process. To generate the keys use the maxkeys command and pass the name of the secrets file in which the keys are stored. - % maxkeys /usr/local/mariadb/maxscale/etc/.secrets + % maxkeys /usr/local/mariadb-maxscale/etc/.secrets % Once the keys have been created the maxpasswd command can be used to generate the encrypted password. @@ -178,7 +178,7 @@ or % service maxscale start -Check the error log in /usr/local/mariadb/maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. +Check the error log in /usr/local/mariadb-maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. % maxadmin -pmariadb list services diff --git a/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md b/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md index 4f91dcda9..5245c65d8 100644 --- a/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md +++ b/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md @@ -62,7 +62,7 @@ If you wish to use two different usernames for the two different roles of monito ### Creating Your MaxScale Configuration -MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb/maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. +MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb-maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. A global, maxscale, section is included within every MaxScale configuration file; this is used to set the values of various MaxScale wide parameters, perhaps the most important of these is the number of threads that MaxScale will use to execute the code that forwards requests and handles responses for clients. @@ -83,7 +83,7 @@ The router for we need to use for this configuration is the readwritesplit modul The final step in the service sections is to add the username and password that will be used to populate the user data from the database cluster. There are two options for representing the password, either plain text or encrypted passwords may be used. In order to use encrypted passwords a set of keys must be generated that will be used by the encryption and decryption process. To generate the keys use the maxkeys command and pass the name of the secrets file in which the keys are stored. - % maxkeys /usr/local/mariadb/maxscale/etc/.secrets + % maxkeys /usr/local/mariadb-maxscale/etc/.secrets % Once the keys have been created the maxpasswd command can be used to generate the encrypted password. @@ -183,7 +183,7 @@ or % service maxscale start -Check the error log in /usr/local/mariadb/maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. +Check the error log in /usr/local/mariadb-maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. % maxadmin -pmariadb list services diff --git a/Tutorials/MySQL-Cluster-Setup.md b/Tutorials/MySQL-Cluster-Setup.md index 21c2ece29..0cf1209a3 100644 --- a/Tutorials/MySQL-Cluster-Setup.md +++ b/Tutorials/MySQL-Cluster-Setup.md @@ -249,7 +249,7 @@ Add these sections in MaxScale.cnf config file: Assuming MaxScale is installed in server1, start it - [root@server1 ~]# cd /usr/local/mariadb/maxscale/bin + [root@server1 ~]# cd /usr/local/mariadb-maxscale/bin [root@server1 bin]# ./maxscale -c ../ diff --git a/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md b/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md index 38c16a3aa..8fd8b496a 100644 --- a/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md +++ b/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md @@ -130,7 +130,7 @@ servers=dbserv1, dbserv2, dbserv3 The final step in the service sections is to add the username and password that will be used to populate the user data from the database cluster. There are two options for representing the password, either plain text or encrypted passwords may be used. In order to use encrypted passwords a set of keys must be generated that will be used by the encryption and decryption process. To generate the keys use the maxkeys command and pass the name of the secrets file in which the keys are stored. -% maxkeys /usr/local/mariadb/maxscale/etc/.secrets +% maxkeys /usr/local/mariadb-maxscale/etc/.secrets % @@ -292,7 +292,7 @@ or % service maxscale start -Check the error log in /usr/local/mariadb/maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. +Check the error log in /usr/local/mariadb-maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. % maxadmin -pmariadb list services diff --git a/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md b/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md index dbc2d4eab..49c151dc2 100644 --- a/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md +++ b/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md @@ -70,7 +70,7 @@ If you wish to use two different usernames for the two different roles of monito ## Creating Your MaxScale Configuration -MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb/maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. +MaxScale configuration is held in an ini file that is located in the file MaxScale.cnf in the directory $MAXSCALE_HOME/etc, if you have installed in the default location then this file is available in /usr/local/mariadb-maxscale/etc/MaxScale.cnf. This is not created as part of the installation process and must be manually created. A template file does exist within this directory that may be use as a basis for your configuration. A global, maxscale, section is included within every MaxScale configuration file; this is used to set the values of various MaxScale wide parameters, perhaps the most important of these is the number of threads that MaxScale will use to execute the code that forwards requests and handles responses for clients. @@ -96,7 +96,7 @@ servers=dbserv1, dbserv2, dbserv3 The final step in the service sections is to add the username and password that will be used to populate the user data from the database cluster. There are two options for representing the password, either plain text or encrypted passwords may be used. In order to use encrypted passwords a set of keys must be generated that will be used by the encryption and decryption process. To generate the keys use the maxkeys command and pass the name of the secrets file in which the keys are stored. -% maxkeys /usr/local/mariadb/maxscale/etc/.secrets +% maxkeys /usr/local/mariadb-maxscale/etc/.secrets % @@ -226,7 +226,7 @@ or % service maxscale start -Check the error log in /usr/local/mariadb/maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. +Check the error log in /usr/local/mariadb-maxscale/log to see if any errors are detected in the configuration file and to confirm MaxScale has been started. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. % maxadmin -pmariadb list services diff --git a/Tutorials/Nagios-Plugins.md b/Tutorials/Nagios-Plugins.md index fb10e7912..9ee3a87c7 100644 --- a/Tutorials/Nagios-Plugins.md +++ b/Tutorials/Nagios-Plugins.md @@ -73,9 +73,9 @@ and add (just after localhost.cfg or commnads.cfg) - modify server IP address in server1.cfg, pointing to MaxScale server - maxadmin executable must be in the nagios server - default MaxScale AdminInterface port is 6603 -- default maxadmin executable path is /usr/local/mariadb/maxscale/bin/maxadmin +- default maxadmin executable path is /usr/local/mariadb-maxscale/bin/maxadmin It can be changed by -m option -- maxadmin executable could be copied from an existing maxscale installation (default location is /usr/local/mariadb/maxscale/bin/maxadmin) +- maxadmin executable could be copied from an existing maxscale installation (default location is /usr/local/mariadb-maxscale/bin/maxadmin) This example shows configuration that needs to be done on Nagios server in order to communicate to MaxScale server that is running on host server1. In this example we are using the check_maxscale_resource as the check command diff --git a/Tutorials/Simple-Sharding-Tutorial.md b/Tutorials/Simple-Sharding-Tutorial.md index 04d78d2d7..6419386fb 100644 --- a/Tutorials/Simple-Sharding-Tutorial.md +++ b/Tutorials/Simple-Sharding-Tutorial.md @@ -92,7 +92,7 @@ After this we have a fully working configuration and we can move on to starting Upon completion of the configuration process MaxScale is ready to be started . This may either be done manually by running the maxscale command or via the service interface. The service scripts are located in the `/etc/init.d/` folder and are accessible through both the `service` and `systemctl` commands. -After starting MaxScale check the error log in /usr/local/mariadb/maxscale/log to see if any errors are detected in the configuration file. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. +After starting MaxScale check the error log in /usr/local/mariadb-maxscale/log to see if any errors are detected in the configuration file. Also the maxadmin command may be used to confirm that MaxScale is running and the services, listeners etc have been correctly configured. MaxScale is now ready to start accepting client connections and routing them. Queries are routed to the right servers based on the database they target and switching between the shards is semaless since MaxScale keeps the session state intact between servers. diff --git a/Upgrading-To-MaxScale-1.1.0.md b/Upgrading-To-MaxScale-1.1.0.md index ddd232613..343fc2fd7 100644 --- a/Upgrading-To-MaxScale-1.1.0.md +++ b/Upgrading-To-MaxScale-1.1.0.md @@ -4,15 +4,15 @@ This document describes upgrading MaxScale from version 1.0.5 to 1.1.0 and the m ## Installation -If you are installing MaxScale from a RPM package, we recommend you back up your configuration and log files and that you remove the old installation of MaxScale completely. If you choose to upgrade MaxScale instead of removing it and re-installing it afterwards, the init scripts in `/etc/init.d` folder will be missing. This is due to the RPM packaging system but the script can be re-installed by running the `postinst` script found in the `/usr/local/mariadb/maxscale` folder. +If you are installing MaxScale from a RPM package, we recommend you back up your configuration and log files and that you remove the old installation of MaxScale completely. If you choose to upgrade MaxScale instead of removing it and re-installing it afterwards, the init scripts in `/etc/init.d` folder will be missing. This is due to the RPM packaging system but the script can be re-installed by running the `postinst` script found in the `/usr/local/mariadb-maxscale` folder. ``` # Re-install init scripts -cd /usr/local/mariadb/maxscale +cd /usr/local/mariadb-maxscale ./postinst ``` -The 1.1.0 version of MaxScale installs into `/usr/local/mariadb/maxscale` instead of `/usr/local/skysql/maxscale`. This will cause external references to MaxScale's home directory to stop working so remember to update all paths with the new version. +The 1.1.0 version of MaxScale installs into `/usr/local/mariadb-maxscale` instead of `/usr/local/skysql/maxscale`. This will cause external references to MaxScale's home directory to stop working so remember to update all paths with the new version. ## MaxAdmin changes
/usr/local/mariadb/maxscale/log/*.log { + /usr/local/mariadb-maxscale/log/*.log { monthly rotate 5 missingok nocompress sharedscripts postrotate -kill -USR1 `cat /usr/local/mariadb/maxscale/log/maxscale.pid` +kill -USR1 `cat /usr/local/mariadb-maxscale/log/maxscale.pid` endscript }