Control Center Upgrade Guide

Transcription

1 Control Center Upgrade Guide Release Zenoss, Inc.

2 Control Center Upgrade Guide Copyright 2017 Zenoss, Inc. All rights reserved. Zenoss, Own IT, and the Zenoss logo are trademarks or registered trademarks of Zenoss, Inc., in the United States and other countries. All other trademarks, logos, and service marks are the property of Zenoss or other third parties. Use of these marks is prohiited without the express written consent of Zenoss, Inc., or the third-party owner. Linux is a registered trademark of Linus Torvalds. All other companies and products mentioned are trademarks and property of their respective owners. Part Numer: Zenoss, Inc Four Points Drive Bldg 1 - Suite 300 Austin, Texas

3 Contents Aout this guide...7 Supported operating systems and rowsers... 7 Documentation feedack...7 Change history... 7 Chapter 1: Documented upgrade paths...10 Release dates...10 Upgrade paths included in this document...11 Chapter 2: Downloading and staging required files...13 Downloading required files Installing the repository mirror...15 Staging Docker image files on the master host Staging a Docker image file on ZooKeeper ensemle nodes Part I: Upgrading 1.3.x or to Chapter 3: Before upgrading from 1.3.x or to New features that affect upgrades...18 Upgrade est practices...19 Chapter 4: Stopping a Control Center deployment Stopping Control Center (single-host deployment)...20 Stopping Control Center (multi-host deployment)...21 Chapter 5: Upgrading a master host from 1.3.x or to Identifying storage for audit logging...25 Updating to Docker CE...25 Loading image files Updating Control Center on the master host Chapter 6: Upgrading delegates from 1.3.x or to Updating to Docker CE...29 Updating Control Center on delegate hosts Updating the ZooKeeper image on ensemle nodes...31 Chapter 7: Starting the ZooKeeper ensemle Chapter 8: After upgrading from 1.3.x or to Removing unused images

4 Part II: Upgrading 1.2.x to Chapter 9: Before upgrading from 1.2.x to New features that affect upgrades from release 1.2.x...37 Upgrade est practices...38 Chapter 10: Stopping a Control Center deployment Stopping Control Center (single-host deployment)...39 Stopping Control Center (multi-host deployment)...40 Chapter 11: Upgrading a master host from 1.2.x to Identifying storage for audit logging...44 Updating to Docker CE...44 Loading image files Updating Control Center on the master host Chapter 12: Upgrading delegates from 1.2.x to Updating to Docker CE...48 Updating Control Center on delegate hosts Updating the ZooKeeper image on ensemle nodes...50 Chapter 13: Starting the ZooKeeper ensemle Chapter 14: After upgrading from 1.2.x to Removing unused images...54 Part III: Upgrading 1.1.x to Chapter 15: Before upgrading from 1.1.x to New features that affect upgrades from 1.1.x...56 Upgrade est practices...57 Chapter 16: Stopping a Control Center deployment Stopping Control Center (single-host deployment)...59 Stopping Control Center (multi-host deployment)...60 Chapter 17: Upgrading a master host from 1.1.x to Identifying storage for audit logging...64 Updating to Docker CE...64 Configuring Docker

5 Optional: Changing the local Docker registry endpoint Loading image files Updating Control Center on the master host Chapter 18: Upgrading delegates from 1.1.x to Updating to Docker CE...71 Configuring Docker Changing the local Docker registry endpoint Updating Control Center on delegate hosts Updating the ZooKeeper image on ensemle nodes...76 Chapter 19: Starting an upgraded deployment...77 Starting and registering the master host (single-host deployment) Starting and registering the master host (multi-host deployment) Updating delegate hosts with authentication...79 Starting the ZooKeeper ensemle Chapter 20: After upgrading from 1.1.x to Updating resource pool permissions Setting the connection timeout of a resource pool...85 Removing unused images...85 Removing orphaned snapshot devices...86 Updating the OpenTSDB time-to-live value...87 Managing maintenance scripts Appendix A: Control Center application data storage requirements...90 Examining application data storage status Adding space to the metadata area of a Control Center thin pool...91 Adding space to the data area of a Control Center thin pool Adding space to a tenant volume...92 Appendix B: Storage management utility...94 serviced-storage...94 Appendix C: User access control...98 Adding users to the default rowser interface access group...98 Configuring a regular group as the Control Center rowser interface access group...99 Enaling use of the command-line interface Appendix D: Configuring a private master NTP server Configuring an NTP master server Configuring NTP clients Appendix E: Resolving package dependency conflicts Resolving device mapper dependency conflicts Resolving other dependency conflicts

6 Appendix F: Control Center releases and images Releases and image tags Identifying installed Docker images Removing unused images Appendix G: Control Center configuration variales Removed variales (at version 1.2.0) New variales (at version 1.2.0) Master host configuration variales Delegate host configuration variales Universal configuration variales Best practices for configuration files Control Center configuration file

7 Aout this guide Aout this guide The Control Center Upgrade Guide provides detailed instructions for performing the following upgrades: Upgrade from version 1.3.x to version Upgrade from version 1.2.x to version Upgrade from version 1.1.x to version Zenoss customers: This guide does not include procedures for upgrading a high-availaility deployment. For more information, refer to the Control Center Upgrade Guide for High-Availaility Deployments. Supported operating systems and rowsers The following tale identifies the supported cominations of client operating systems and we rowsers. Client OS Supported Browsers Windows 7 and 8.1 Internet Explorer 11 * Windows 10 Windows Server 2012 R2 Macintosh OS/X 10.9 Uuntu LTS Red Hat Enterprise Linux 6.5, CentOS 6.5 Internet Explorer 11 * Firefox 50 and later Chrome 54 and later Microsoft Edge Firefox 30 Chrome 36 Firefox 30 and aove Chrome 36 and aove Firefox 30 and aove Chrome 37 and aove Firefox 30 and aove Chrome 37 and aove Documentation feedack To provide feedack aout this document, or to report an error or omission, please send an to docs@controlcenter.io. In the , please include the document title (Control Center Upgrade Guide) and part numer ( ) and as much information as possile aout the context of your feedack. Change history The following list associates document part numers and the important changes to this guide since the previous release. Some of the changes involve features or content, ut others do not. For information aout new or changed features, refer to the Control Center Release Notes. * Enterprise mode only; compatiility mode is not supported. 7

8 Control Center Upgrade Guide Update release numer (1.4.1) Update release numer (1.4.0). Correct a previous modification for configuring Docker. The --insecure-registry flag must e set when the value of SERVICED_DOCKER_REGISTRY is not localhost: Modify the yum command used to install Docker CE Update release numer (1.3.3). Add support for Docker CE Add ZooKeeper variales for tuning TCP/IP communications with resource pools. Remove step for disaling SELinux Update release numer (1.3.2) Update release numer (1.3.1). Add a part for upgrading 1.3.x systems to the latest release. Move thin pool resize procedures to an appendix. Modify the step for configuring Docker on master hosts. The --insecure-registry flag is only needed on delegate hosts. Move information aout Docker images to an appendix Update release numer (1.3.0). Change space requirements for the master Update release numer (1.2.3). Remove TLS_RSA_WITH_RC4_128_SHA from list of ciphers associated with SERVICED_TLS_CIPHERS. Remove section for configuring dnsmasq Update release numer (1.2.2) Add sections for configuring dnsmasq and removing consistent network device naming. Simplify Docker install and configuration steps. Add sections aout the maintenance scripts that are installed Add a chapter of details aout releases and upgrades. Create a part for the minor release upgrade chapters. Add a part and new chapters for micro release upgrades. Add steps to download and use the serviced RPM file (Zenoss customers only). Add a procedure for updating ZooKeeper images on offline nodes (Zenoss customers only). Clarify the procedures for stopping a cluster. Update release numer (1.2.1). 8

9 Aout this guide Add a description of a new feature, setting the connection timeout value of a resource pool, to the preupgrade chapter. Add a procedure for the new feature to the post-upgrade chapter Initial release (1.2.0). 9

10 Control Center Upgrade Guide Documented upgrade paths 1 This chapter includes the dates of Control Center releases and the upgrade paths that are documented in this guide. Release dates Tale 1: Release 1.4 Release Date Control Center Sep 2017 Control Center Aug 2017 Tale 2: Release 1.3 Release Date Control Center Jun 2017 Control Center May 2017 Control Center Apr 2017 Control Center Mar 2017 Tale 3: Release 1.2 Release Date Control Center Fe 2017 Control Center Jan 2017 Control Center Dec 2016 Control Center Nov

11 Documented upgrade paths Tale 4: Release 1.1 Release Date Control Center Nov 2016 Control Center Oct 2016 Control Center Sep 2016 Control Center Jul 2016 Control Center Jun 2016 Control Center Jun 2016 Control Center May 2016 Control Center Apr 2016 Control Center Mar 2016 Control Center Fe 2016 Tale 5: Release 1.0 Release Date Control Center Fe 2016 Control Center Dec 2015 Control Center Nov 2015 Control Center Oct 2015 Control Center Sep 2015 Control Center Aug 2015 Control Center Jul 2015 Control Center May 2015 Control Center Apr 2015 Control Center Apr 2015 Control Center Fe 2015 Upgrade paths included in this document Release 1.3.x and upgrades From To Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center

12 Control Center Upgrade Guide From Control Center Control Center To Release 1.2.x upgrades From To Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Release 1.1.x upgrades From To Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center

13 Downloading and staging required files Downloading and staging required files 2 This chapter descries how to download and install or stage Control Center software and its operating system dependencies. The procedures in this chapter are required to perform an upgrade. The following tale identifies where to perform each procedure in this chapter. Procedure Downloading required files on page 13 Installing the repository mirror on page 15 Staging Docker image files on the master host on page 15 Staging a Docker image file on ZooKeeper ensemle nodes on page 16 Where to perform A workstation with internet access All Control Center cluster hosts The master host Delegate hosts that are ZooKeeper ensemle nodes Downloading required files Perform one of the procedures in this section. Downloading Control Center files (Zenoss Resource Manager users) To perform this procedure, you need: A workstation with internet access. Permission to download files from the File Portal - Download Zenoss Enterprise Software site. Zenoss customers can request permission y filing a ticket at the Zenoss Support site. A secure network copy program. Use this procedure to download the required files to a workstation copy the files to the hosts that need them Perform these steps: 1 In a we rowser, navigate to the File Portal - Download Zenoss Enterprise Software site. 2 Log in with the account provided y Zenoss Support. 3 Download the self-installing Docker image files. 13

14 Control Center Upgrade Guide install-zenoss-serviced-isvcs-v60.run install-zenoss-isvcs-zookeeper-v10.run 4 Download the Control Center RPM file. serviced x86_64.rpm 5 Download a RHEL/CentOS repository mirror file. The download site provides a repository mirror file for each supported release of RHEL/CentOS. Each file contains the Control Center dependencies. To download the correct repository mirror file, match the operating system release numer in the file name with the version of RHEL/CentOS installed on all of the hosts in your Control Center cluster. yum-mirror-centos7.centos serviced x86_64.rpm yum-mirror-centos7.centos serviced x86_64.rpm yum-mirror-centos7.centos serviced x86_64.rpm 6 Use a secure copy program to copy the files to Control Center cluster hosts. Copy all files to the master host. Copy the RHEL/CentOS RPM file and the Control Center RPM file to all delegate hosts. Copy the Docker image file for ZooKeeper to delegate hosts that are ZooKeeper ensemle nodes. Downloading Control Center files (Zenoss Core users) To perform this procedure, you need: A workstation with internet access. An account on the Zenoss Community site. A secure network copy program. Use this procedure to download the required files to a workstation copy the files to the hosts that need them Perform these steps: 1 In a we rowser, navigate to the Zenoss Community site, and then log in with your account. 2 Download the self-installing Docker image files. install-zenoss-serviced-isvcs-v60.run install-zenoss-isvcs-zookeeper-v10.run 3 Download the Control Center RPM file. serviced x86_64.rpm 4 Download a RHEL/CentOS repository mirror file. The download site provides a repository mirror file for each supported release of RHEL/CentOS. Each file contains the Control Center dependencies. To download the correct repository mirror file, match the operating system release numer in the file name with the version of RHEL/CentOS installed on all of the hosts in your Control Center cluster. yum-mirror-centos7.centos serviced x86_64.rpm yum-mirror-centos7.centos serviced x86_64.rpm yum-mirror-centos7.centos serviced x86_64.rpm 14

15 Downloading and staging required files 5 Use a secure copy program to copy the files to Control Center cluster hosts. Copy all files to the master host. Copy the RHEL/CentOS RPM file and the Control Center RPM file to all delegate hosts. Copy the Docker image file for ZooKeeper to delegate hosts that are ZooKeeper ensemle nodes. Installing the repository mirror Use this procedure to install the Zenoss repository mirror on a Control Center host. The mirror contains packages that are required on all Control Center cluster hosts. 1 Log in to the target host as root, or as a user with superuser privileges. 2 Move the RPM files to /tmp. 3 Optional: Remove the existing repository mirror, if necessary. a Search for the mirror. yum list --disalerepo=* awk '/^yum-mirror/ { print $1}' Remove the mirror. Replace Old-Mirror with the name of the Zenoss repository mirror returned in the previous sustep: yum remove Old-Mirror 4 Install the new repository mirror. yum install /tmp/yum-mirror-*.rpm The yum command copies the contents of the RPM file to /opt/zenoss-repo-mirror. 5 Move the Control Center RPM file to the mirror directory. mv /tmp/serviced x86_64.rpm \ /opt/zenoss-repo-mirror 6 Optional: Delete the mirror package file, if desired. rm /tmp/yum-mirror-*.rpm Staging Docker image files on the master host Before performing this procedure, verify that approximately 640MB of temporary space is availale on the file system where /root is located. Use this procedure to add Docker image files to the Control Center master host. The files are used when Docker is fully configured. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Copy or move the archive files to /root. 3 Add execute permission to the files. chmod +x /root/*.run 15

16 Control Center Upgrade Guide Staging a Docker image file on ZooKeeper ensemle nodes Before performing this procedure, verify that approximately 170MB of temporary space is availale on the file system where /root is located. Use this procedure to add a Docker image file to the Control Center delegate hosts that are ZooKeeper ensemle nodes. Delegate hosts that are not ZooKeeper ensemle nodes do not need the file. The files are used when the ZooKeeper ensemle is configured. 1 Log in to a delegate host as root, or as a user with superuser privileges. 2 Copy or move the install-zenoss-isvcs-zookeeper-v10.run file to /root. 3 Add execute permission to the file. chmod +x /root/*.run 16

17 Upgrading 1.3.x or to Part I: Upgrading 1.3.x or to The chapters in this part provide instructions for upgrading Control Center from version 1.3.x or to The following tale identifies the upgrades of Control Center that are documented in this part. From To Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center

18 Control Center Upgrade Guide Before upgrading from 1.3.x or to This chapter provides information and procedures to prepare a Control Center deployment for an upgrade from 1.3.x or to New features that affect upgrades This release includes new features and new requirements that affect the upgrade process. The following list provides an overview of the changes that are addressed during this upgrade. The upgrade (and install) process now requires downloading packages from Zenoss manually. The required software and images are no longer availale from the online Zenoss repository or Docker Hu. For more information, see Downloading and staging required files on page 13. The packages to download include a yum repository mirror that contains the required dependencies of Docker CE and Control Center. An operating system or kernel upgrade can install newer versions of the dependencies included in the mirror, and when you attempt to upgrade Docker CE or Control Center, yum will stop when it finds the newer versions. A new appendix in this document includes workarounds for the most common dependency conflicts. This release includes a new feature, serviced and application audit logging. By default, audit logging requires 10GB of storage on the master host. The upgrade process includes a procedure for adding space to the master host, if necessary. For more information aout audit logging, refer to the Control Center Reference Guide. A new configuration variale, SERVICED_LOG_PATH, sets the location for audit logs. The default location is /var/log/serviced. This release replaces Docker with Docker Community Edition (CE) in Control Center 1.3.0, 1.3.1, and The following new configuration variales are availale in /etc/default/serviced, for tuning TCP/ IP communications etween ZooKeeper ensemle hosts and Control Center: SERVICED_ZK_CONNECT_TIMEOUT SERVICED_ZK_PER_HOST_CONNECT_DELAY SERVICED_ZK_RECONNECT_START_DELAY SERVICED_ZK_RECONNECT_MAX_DELAY For more information, see Control Center configuration file on page 118. The Control Center RPM package includes a script that adds the serviced user group to a host, if necessary. Users must e memers of the serviced group to use the command-line interface. For more information, see User access control on page

19 Before upgrading from 1.3.x or to For more information aout this release, refer to the Control Center Release Notes. Upgrade est practices The following list outlines recommended est practices for upgrading Control Center deployments: 1 Download a copy of the Control Center Release Notes for this release and review its contents. The latest information is included in that document. 2 Compare the Docker images that accompany this release with the images that accompany the installed release, and determine whether the image files need to e downloaded and installed. For more information, see Releases and image tags on page On delegate hosts, most of the upgrade steps are identical. Use screen, tmux or a similar program to estalish sessions on each delegate host and perform the steps at the same time. 4 Review and verify the settings in delegate host configuration files (/etc/default/serviced) efore starting the upgrade. Ideally, the settings on all delegate hosts are identical, except on ZooKeeper nodes and delegate hosts that do not mount the DFS. 5 Review the procedures in this guide efore performing them. Every effort is made to avoid mistakes and anticipate needs; nevertheless, the instructions may e incorrect or inadequate for some requirements or environments. 6 Download and stage the required files for your upgrade. For more information, see Downloading and staging required files on page

20 Control Center Upgrade Guide Stopping a Control Center deployment 4 This chapter includes procedures for stopping oth single-host and multi-host Control Center deployments. Note The procedures in this chapter assume that Control Center is the only source of Docker containers that are run on Control Center cluster hosts. Stopping Control Center (single-host deployment) Use this procedure to stop the Control Center service (serviced) in a single-host deployment. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Stop the top-level service serviced is managing, if necessary. a Show the status of running services. serviced service status The top-level service is the service listed immediately elow the headings line. c If the status of the top-level service and all child services is stopped, proceed to the next step. If the status of the top-level service and all child services is not stopped, perform the remaining susteps. Stop the top-level service. Replace Service with the name or identifier of the top-level service: serviced service stop Service Monitor the stop. serviced service status When the status of the top-level service and all child services is stopped, proceed to the next step. 3 Stop the Control Center service. systemctl stop serviced 4 Ensure that no containers remain in the local repository. 20

21 Stopping a Control Center deployment a Display the identifiers of all containers, running and exited. docker ps -qa c If the command returns no result, stop. This procedure is complete. If the command returns a result, perform the following susteps. Remove all remaining containers. docker ps -qa xargs --no-run-if-empty docker rm -fv Display the identifiers of all containers, running and exited. docker ps -qa d e f g If the command returns no result, stop. This procedure is complete. If the command returns a result, perform the remaining susteps. Disale the automatic startup of serviced. systemctl disale serviced Reoot the host. reoot Log in to the master host as root, or as a user with superuser privileges. Enale the automatic startup of serviced. systemctl enale serviced Stopping Control Center (multi-host deployment) To stop Control Center in a multi-host deployment, perform the procedures in this section, in order. Stopping a master host (multi-host deployment) Use this procedure to stop the Control Center service (serviced) on the master host in a multi-host deployment. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Stop the top-level service serviced is managing, if necessary. a Show the status of running services. serviced service status The top-level service is the service listed immediately elow the headings line. If the status of the top-level service and all child services is stopped, proceed to the next step. If the status of the top-level service and all child services is not stopped, perform the remaining susteps. Stop the top-level service. 21

22 Control Center Upgrade Guide Replace Service with the name or identifier of the top-level service: c serviced service stop Service Monitor the stop. serviced service status When the status of the top-level service and all child services is stopped, proceed to the next step. 3 Stop the Control Center service. systemctl stop serviced 4 Ensure that no containers remain in the local repository. a Display the identifiers of all containers, running and exited. docker ps -qa c If the command returns no result, stop. This procedure is complete. If the command returns a result, perform the following susteps. Remove all remaining containers. docker ps -qa xargs --no-run-if-empty docker rm -fv Display the identifiers of all containers, running and exited. docker ps -qa d e f g If the command returns no result, stop. This procedure is complete. If the command returns a result, perform the remaining susteps. Disale the automatic startup of serviced. systemctl disale serviced Reoot the host. reoot Log in to the master host as root, or as a user with superuser privileges. Enale the automatic startup of serviced. systemctl enale serviced Stopping a delegate host Use this procedure to stop the Control Center service (serviced) on a delegate host in a multi-host deployment. Repeat this procedure on each delegate host in your deployment. 1 Log in to the delegate host as root, or as a user with superuser privileges. 2 Stop the Control Center service. systemctl stop serviced 22

23 Stopping a Control Center deployment 3 Ensure that no containers remain in the local repository. a Display the identifiers of all containers, running and exited. docker ps -qa If the command returns no result, proceed to the next step. If the command returns a result, perform the following susteps. Remove all remaining containers. docker ps -qa xargs --no-run-if-empty docker rm -fv c d e If the remove command completes, proceed to the next step. If the remove command does not complete, the most likely cause is an NFS conflict. Perform the following susteps. Stop the NFS and Docker services. systemctl stop nfs && systemctl stop docker Start the NFS and Docker services. systemctl start nfs && systemctl start docker Repeat the attempt to remove all remaining containers. docker ps -qa xargs --no-run-if-empty docker rm -fv f g h i If the remove command completes, proceed to the next step. If the remove command does not complete, perform the remaining susteps. Disale the automatic startup of serviced. systemctl disale serviced Reoot the host. reoot Log in to the delegate host as root, or as a user with superuser privileges. Enale the automatic startup of serviced. systemctl enale serviced 4 Dismount all filesystems mounted from the Control Center master host. This step ensures no stale mounts remain when the storage on the master host is replaced. a Identify filesystems mounted from the master host. awk '/serviced/ { print $1, $2 }' < /proc/mounts \ grep -v '/opt/serviced/var/isvcs' If the preceding command returns no result, stop. This procedure is complete. If the preceding command returns a result, perform the following susteps. 23

24 Control Center Upgrade Guide c Force the filesystems to dismount. for FS in $(awk '/serviced/ { print $2 }' < /proc/mounts \ grep -v '/opt/serviced/var/isvcs') do umount -f $FS done Identify filesystems mounted from the master host. awk '/serviced/ { print $1, $2 }' < /proc/mounts \ grep -v '/opt/serviced/var/isvcs' d e f If the preceding command returns no result, stop. This procedure is complete. If the preceding command returns a result, perform the following susteps. Perform a lazy dismount. for FS in $(awk '/serviced/ { print $2 }' < /proc/mounts \ grep -v '/opt/serviced/var/isvcs') do umount -f -l $FS done Restart the NFS service. systemctl restart nfs Determine whether any filesystems remain mounted from the master host. awk '/serviced/ { print $1, $2 }' < /proc/mounts \ grep -v '/opt/serviced/var/isvcs' g h i j If the preceding command returns no result, stop. This procedure is complete. If the preceding command returns a result, perform the remaining susteps. Disale the automatic startup of serviced. systemctl disale serviced Reoot the host. reoot Log in to the delegate host as root, or as a user with superuser privileges. Enale the automatic startup of serviced. systemctl enale serviced 24

25 Upgrading a master host from 1.3.x or to Upgrading a master host from 1.3.x or to Use this chapter to upgrade a Control Center 1.3.x or master host to Before performing the procedures in this chapter, download required software. See Downloading and staging required files on page 13. Identifying storage for audit logging The default configuration of Control Center audit logging requires 10GB of storage in /var/log/serviced on the master host. Use this procedure to determine whether sufficient space is availale. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Display the amount of space availale in /var/log. The /var/log/serviced directory does not exist until Control Center is upgraded. df -h /var/log Typically, /var/log is mounted on the root filesystem, /. 3 Display the amount of space availale in /tmp. Docker requires 10GB of storage for temporary files, and the Control Center Installation Guide includes instructions to link the Docker temporary directory to /tmp. df -h /tmp Like /var/log, /tmp is typically mounted on the root filesystem, /. If /var/log and /tmp each have 10GB of availale storage, for a comined total of 20GB, then the master host has sufficient space for audit logging. Otherwise, you must choose one of the following alternatives: After upgrading Control Center, mount the serviced audit log directory on a larger local or remote file system, modify the settings in the /opt/serviced/etc/logrotate.conf configuration file. Use a cron jo to copy the files to a larger local or remote file system. Forward the log files to a log management application. Updating to Docker CE Use this procedure to update Docker to Docker Community Edition (Docker CE) version Note If you are upgrading Control Center or 1.4.0, skip this procedure. Docker CE is already installed. 25

26 Control Center Upgrade Guide 1 Log in as root, or as a user with superuser privileges. 2 Remove the Docker repository description file, if present. Upgrades no longer require external repositories. rm -f /etc/yum.repos.d/docker.repo 3 Update the Linux kernel, if necessary. a Determine which kernel version is installed. uname -r If the result is lower than el7.x86_64, perform the following susteps. Disale automatic start of serviced. systemctl disale serviced c Update the kernel, and then restart the host. The following commands require internet access or a local mirror of operating system packages. yum makecache fast && yum update kernel && reoot d e Log in as root, or as a user with superuser privileges. Enale automatic start of serviced. systemctl enale serviced 4 Stop the Docker service. systemctl stop docker 5 Remove Docker a Remove without checking dependencies. rpm -e --nodeps docker-engine Clean the yum dataases. yum clean all 6 Install Docker CE yum install --enalerepo=zenoss-mirror docker-ce ce If yum returns an error due to dependency issues, see Resolving package dependency conflicts on page 104 for potential resolutions. 7 Start the Docker service. systemctl start docker Loading image files Perform the steps in Downloading and staging required files on page 13 efore performing this procedure. Use this procedure to load images into the local Docker registry. 26

27 Upgrading a master host from 1.3.x or to Log in to the master host as root, or as a user with superuser privileges. 2 Change directory to /root. cd /root 3 Extract the images. for image in install-*.run do echo -n "$image: "./$image done Image extraction egins when you press the y key. If you press the y key and then Return key, the current image is extracted, ut the next one is not. 4 List the images in the registry. docker images The result should show one image for each archive file. 5 Optional: Delete the archive files. rm -i./install-*.run Updating Control Center on the master host Use this procedure to update Control Center on the master host to version Log in to the master host as root, or as a user with superuser privileges. 2 Save the current serviced configuration file as a reference. a Rename the file. mv /etc/default/serviced /etc/default/serviced-pre Set permissions to read-only. chmod 0440 /etc/default/serviced-pre Remove the external Zenoss repository package. Upgrades no longer require external repositories. yum remove zenoss-repo-1-1.x86_64 4 Install the new version of Control Center. yum install --enalerepo=zenoss-mirror \ /opt/zenoss-repo-mirror/serviced x86_64.rpm If yum returns an error due to dependency issues, see Resolving package dependency conflicts on page 104 for potential resolutions. 5 Make a ackup copy of the new configuration file. a Copy the file. cp /etc/default/serviced /etc/default/serviced orig 27

28 Control Center Upgrade Guide Set permissions to read-only. chmod 0440 /etc/default/serviced orig 6 Compare the new configuration file with the configuration file of the previous release. a Identify the configuration files to compare. ls -l /etc/default/serviced* The original versions of the configuration files should end with orig, ut you may have to compare the dates of the files. Compare the new and previous configuration files. Replace New-Version with the name of the new configuration file, and replace Previous-Version with the name of the previous configuration file: diff New-Version Previous-Version For example, to compare versions and 1.4.1, enter the following command: diff /etc/default/serviced orig \ /etc/default/serviced orig If the command returns no result, restore the ackup of the previous configuration file. cp /etc/default/serviced-pre \ /etc/default/serviced && chmod 0644 /etc/default/serviced If the command returns a result, restore the ackup of the previous configuration file, and then optionally, use the results to edit the restored version. cp /etc/default/serviced-pre \ /etc/default/serviced && chmod 0644 /etc/default/serviced For more information aout configuring the master host, see Control Center configuration variales on page Update the log file management configuration file, if necessary. The default configuration of the /opt/serviced/etc/logrotate.conf file now uses file size rather than file age to determine when to rotate logs. If you customized /opt/serviced/etc/ logrotate.conf for your environment, your customizations are saved in /opt/serviced/etc/ logrotate.conf.ak. Compare the new and old versions, and update the new one as desired. If you are upgrading a multi-host deployment, continue to the next procedure. If you are upgrading a single-host deployment, start Control Center. systemctl daemon-reload && systemctl start serviced 28

29 Upgrading delegates from 1.3.x or to Upgrading delegates from 1.3.x or to Use this chapter to upgrade Control Center 1.3.x or delegate hosts to Before performing the procedures in this chapter, download required software. See Downloading and staging required files on page 13. Updating to Docker CE Use this procedure to update Docker to Docker Community Edition (Docker CE) version Note If you are upgrading Control Center or 1.4.0, skip this procedure. Docker CE is already installed. 1 Log in as root, or as a user with superuser privileges. 2 Remove the Docker repository description file, if present. Upgrades no longer require external repositories. rm -f /etc/yum.repos.d/docker.repo 3 Update the Linux kernel, if necessary. a Determine which kernel version is installed. uname -r If the result is lower than el7.x86_64, perform the following susteps. Disale automatic start of serviced. systemctl disale serviced c Update the kernel, and then restart the host. The following commands require internet access or a local mirror of operating system packages. yum makecache fast && yum update kernel && reoot d e Log in as root, or as a user with superuser privileges. Enale automatic start of serviced. systemctl enale serviced 29

30 Control Center Upgrade Guide 4 Stop the Docker service. systemctl stop docker 5 Remove Docker a Remove without checking dependencies. rpm -e --nodeps docker-engine Clean the yum dataases. yum clean all 6 Install Docker CE yum install --enalerepo=zenoss-mirror docker-ce ce If yum returns an error due to dependency issues, see Resolving package dependency conflicts on page 104 for potential resolutions. 7 Start the Docker service. systemctl start docker Updating Control Center on delegate hosts This procedure updates Control Center on delegate hosts to version Perform this procedure on each delegate host in your deployment. 1 Log in to a delegate host as root, or as a user with superuser privileges. 2 Save the current serviced configuration file as a reference. a Rename the file. mv /etc/default/serviced /etc/default/serviced-pre Set permissions to read-only. chmod 0440 /etc/default/serviced-pre Remove the external Zenoss repository package. Upgrades no longer require external repositories. yum remove zenoss-repo-1-1.x86_64 4 Install the new version of Control Center. yum install --enalerepo=zenoss-mirror \ /opt/zenoss-repo-mirror/serviced x86_64.rpm If yum returns an error due to dependency issues, see Resolving package dependency conflicts on page 104 for potential resolutions. 5 Make a ackup copy of the new configuration file. 30

31 Upgrading delegates from 1.3.x or to a Copy the file. cp /etc/default/serviced /etc/default/serviced orig Set permissions to read-only. chmod 0440 /etc/default/serviced orig 6 Compare the new configuration file with the configuration file of the previous release. a Identify the configuration files to compare. ls -l /etc/default/serviced* The original versions of the configuration files should end with orig, ut you may have to compare the dates of the files. Compare the new and previous configuration files. Replace New-Version with the name of the new configuration file, and replace Previous-Version with the name of the previous configuration file: diff New-Version Previous-Version For example, to compare versions and 1.4.1, enter the following command: diff /etc/default/serviced orig \ /etc/default/serviced orig If the command returns no result, restore the ackup of the previous configuration file. cp /etc/default/serviced-pre \ /etc/default/serviced && chmod 0644 /etc/default/serviced If the command returns a result, restore the ackup of the previous configuration file, and then optionally, use the results to edit the restored version. cp /etc/default/serviced-pre \ /etc/default/serviced && chmod 0644 /etc/default/serviced For more information aout configuring a delegate host, see Control Center configuration variales on page 109. Updating the ZooKeeper image on ensemle nodes Perform the steps in Downloading and staging required files on page 13 efore performing this procedure. Use this procedure to install a new Docker image for ZooKeeper on ZooKeeper ensemle nodes. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Identify the hosts in the ZooKeeper ensemle. grep -E '^\*SERVICED_ZK=' /etc/default/serviced The result is a list of 3 or 5 hosts, separated y the comma character (,). The master host is always a node in the ZooKeeper ensemle. 3 Log in to a ZooKeeper ensemle node as root, or as a user with superuser privileges. 31

32 Control Center Upgrade Guide 4 Change directory to /root. cd /root 5 Extract the ZooKeeper image../install-zenoss-isvcs-zookeeper-v*.run Image extraction egins when you press the y key. 6 Optional: Delete the archive file. rm -i./install-zenoss-isvcs-zookeeper-v*.run 7 Repeat the preceding four steps on each delegate that is a node in the ZooKeeper ensemle. 32

33 Starting the ZooKeeper ensemle Starting the ZooKeeper ensemle 7 Use this procedure to start the ZooKeeper ensemle. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Determine whether serviced is configured to start when the system starts. systemctl is-enaled serviced If the result is enaled, proceed to the next step. If the result is disaled, enter the following command: systemctl enale serviced 3 Identify the hosts in the ZooKeeper ensemle. grep -E '^\*SERVICED_ZK=' /etc/default/serviced The result is a list of 3 or 5 hosts, separated y the comma character (,). The master host is always a node in the ZooKeeper ensemle. 4 In separate windows, log in to each of the delegate hosts that are nodes in the ZooKeeper ensemle as root, or as a user with superuser privileges. 5 On all ensemle hosts, start serviced. The window of time for starting a ZooKeeper ensemle is relatively short. The goal of this step is to start Control Center on each ensemle node at aout the same time, so that each node can participate in electing the leader. systemctl daemon-reload && systemctl start serviced 6 On the master host, check the status of the ZooKeeper ensemle. a Attach to the container of the ZooKeeper service. docker exec -it serviced-isvcs_zookeeper /in/ash Query the master host and identify its role in the ensemle. Replace Master with the hostname or IP address of the master host: { echo stats; sleep 1; } nc Master 2181 grep Mode 33

34 Control Center Upgrade Guide c d The result includes leader or follower. Query the other delegate hosts to identify their role in the ensemle. Replace Delegate with the hostname or IP address of a delegate host: { echo stats; sleep 1; } nc Delegate 2181 grep Mode Detach from the container of the ZooKeeper service. exit If none of the nodes reports that it is the ensemle leader within a few minutes of starting serviced, reoot the ensemle hosts. 34

35 After upgrading from 1.3.x or to After upgrading from 1.3.x or to Perform the procedures in this chapter after Control Center is upgraded. Removing unused images Use this procedure to identify and remove unused Control Center images. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Identify the images associated with the installed version of serviced. serviced version grep Images Example result: IsvcsImages: [zenoss/serviced-isvcs:v60 zenoss/isvcs-zookeeper:v10] 3 Display the serviced images in the local repository. docker images awk '/REPO isvcs/' Example result (edited to fit): REPOSITORY TAG IMAGE ID zenoss/serviced-isvcs v40 88cd6c24cc82 zenoss/serviced-isvcs v60 0aa5a2123f2 zenoss/isvcs-zookeeper v3 46fa0a2fc4f zenoss/isvcs-zookeeper v10 0ff33117f8 The example result shows the current versions and one set of previous versions. Your result may include additional previous versions and will show different images IDs. 4 Remove unused images. Replace Image-ID with the image ID of an image for a previous version. docker rmi Image-ID Repeat this command for each unused image. 35

36 Control Center Upgrade Guide Part II: Upgrading 1.2.x to The chapters in this part provide instructions for upgrading Control Center from version 1.2.x to The following tale identifies the upgrades of Control Center that are documented in this part. From To Control Center Control Center Control Center Control Center Control Center Control Center Control Center Control Center

37 Before upgrading from 1.2.x to Before upgrading from 1.2.x to This chapter provides information and procedures to prepare a Control Center deployment for an upgrade from 1.2.x to New features that affect upgrades from release 1.2.x This release includes new features and new requirements that affect the upgrade process. The following list provides an overview of the changes that are addressed during this upgrade. The upgrade (and install) process now requires downloading packages from Zenoss manually. The required software and images are no longer availale from the online Zenoss repository or Docker Hu. For more information, see Downloading and staging required files on page 13. The packages to download include a yum repository mirror that contains the required dependencies of Docker CE and Control Center. An operating system or kernel upgrade can install newer versions of the dependencies included in the mirror, and when you attempt to upgrade Docker CE or Control Center, yum will stop when it finds the newer versions. A new appendix in this document includes workarounds for the most common dependency conflicts. This release includes a new feature, serviced and application audit logging. By default, audit logging requires 10GB of storage on the master host. The upgrade process includes a procedure for adding space to the master host, if necessary. For more information aout audit logging, refer to the Control Center Reference Guide. A new configuration variale, SERVICED_LOG_PATH, sets the location for audit logs. The default location is /var/log/serviced. When storage ecomes critically low, Control Center initiates an emergency shutdown of applications and services while sufficient resources remain to take action to avoid data loss. Support for this feature requires specific minimum amounts of space in the Control Center thin pool for application data. Note Before upgrading, determine whether the thin pool is adequate and if necessary, resize it. For more information, see Control Center application data storage requirements on page 90. This release replaces Docker with Docker Community Edition (CE) The following new configuration variales are availale in /etc/default/serviced, for tuning TCP/ IP communications etween ZooKeeper ensemle hosts and Control Center: SERVICED_ZK_CONNECT_TIMEOUT SERVICED_ZK_PER_HOST_CONNECT_DELAY SERVICED_ZK_RECONNECT_START_DELAY 37

38 Control Center Upgrade Guide SERVICED_ZK_RECONNECT_MAX_DELAY For more information, see Control Center configuration file on page 118. The Control Center RPM package includes a script that adds the serviced user group to a host, if necessary. Users must e memers of the serviced group to use the command-line interface. For more information, see User access control on page 98. For more information aout this release, refer to the Control Center Release Notes. Upgrade est practices The following list outlines recommended est practices for upgrading Control Center deployments: 1 Download a copy of the Control Center Release Notes for this release and review its contents. The latest information is included in that document. 2 Compare the Docker images that accompany this release with the images that accompany the installed release, and determine whether the image files need to e downloaded and installed. For more information, see Releases and image tags on page On delegate hosts, most of the upgrade steps are identical. Use screen, tmux or a similar program to estalish sessions on each delegate host and perform the steps at the same time. 4 Review and verify the settings in delegate host configuration files (/etc/default/serviced) efore starting the upgrade. Ideally, the settings on all delegate hosts are identical, except on ZooKeeper nodes and delegate hosts that do not mount the DFS. 5 Review the procedures in this guide efore performing them. Every effort is made to avoid mistakes and anticipate needs; nevertheless, the instructions may e incorrect or inadequate for some requirements or environments. 6 Download and stage the required files for your upgrade. For more information, see Downloading and staging required files on page

39 Stopping a Control Center deployment Stopping a Control Center deployment 10 This chapter includes procedures for stopping oth single-host and multi-host Control Center deployments. Note The procedures in this chapter assume that Control Center is the only source of Docker containers that are run on Control Center cluster hosts. Stopping Control Center (single-host deployment) Use this procedure to stop the Control Center service (serviced) in a single-host deployment. 1 Log in to the master host as root, or as a user with superuser privileges. 2 Stop the top-level service serviced is managing, if necessary. a Show the status of running services. serviced service status The top-level service is the service listed immediately elow the headings line. c If the status of the top-level service and all child services is stopped, proceed to the next step. If the status of the top-level service and all child services is not stopped, perform the remaining susteps. Stop the top-level service. Replace Service with the name or identifier of the top-level service: serviced service stop Service Monitor the stop. serviced service status When the status of the top-level service and all child services is stopped, proceed to the next step. 3 Stop the Control Center service. systemctl stop serviced 4 Ensure that no containers remain in the local repository. 39