Package: cloudify-cluster-manager
Cloudify Cluster ManagerThe purpose of the Cloudify Cluster Manager package is to automate the procedure of installing a Cloudify
cluster on existing VMs. The following article will guide you through the different steps of
easily installing a Cloudify cluster on either three or nine VMs.Table of ContentsInstallationChoosing a cluster configurationInstalling the Cloudify Cluster Manager packageInstalling using an RPMInstalling using pip installUsing the Cloudify Cluster Manager packageGenerating a configuration fileFilling in the configuration fileInstalling a Cloudify clusterRemoving a Cloudify clusterUpgrading a Cloudify clusterFault tolerance mechanismsInstallationChoosing a cluster configurationBefore using the Cloudify Cluster Manager package you must prepare a set of VMs for your cluster.
The Cloudify Cluster Manager package supports all cloud providers and the following configurations:Nine VMs.Three VMs.Six VMs with an external DB.Three VMs with an external DB.Please follow theprerequisites and sizing guidelines on Cloudify documentationand generate the required number of VMs according to the mentioned spec. You should also prepare a load balancer to distribute the load over the managers.NOTEThe Cloudify Cluster Manager package is currently supported over CentOS or RHEL OS.A load-balancer is required for load distribution over the managers.
The setup will expect a load balancer address. The Cloudify Cluster Manager package does not install the load balancer.Installing the Cloudify Cluster Manager packageYou can run the Cloudify Cluster Manager package from one of the cluster's VMs, or from a different host in the
cluster network. You can install the package either by using an RPM or by usingpip install:Installing using an RPMRun the following command:sudoyuminstall-yhttp://repository.cloudifysource.org/cloudify/cloudify-cluster-manager/1.1.7/ga-release/cloudify-cluster-manager-1.1.7-ga.el7.x86_64.rpm# Installing haveged to avoid hanging executionscurlhttps://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm-oepel-release-latest-7.noarch.rpm
sudoyuminstall-yepel-release-latest-7.noarch.rpm
sudoyuminstall-yhaveged
sudosystemctlstarthavegedNOTE:On RHEL 8, install haveged as follows instead:curlhttps://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm-oepel-release-latest-8.noarch.rpm
sudoyuminstall-yepel-release-latest-8.noarch.rpm
sudoyuminstall-yhaveged
sudosystemctlstarthavegedInstalling using pip installpipinstallcloudify-cluster-manager# Installing haveged to avoid hanging executionscurlhttps://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm-oepel-release-latest-7.noarch.rpm
sudoyuminstall-yepel-release-latest-7.noarch.rpm
sudoyuminstall-yhaveged
sudosystemctlstarthavegedUsing the Cloudify Cluster Manager packageOnce the VMs are ready, using the Cloudify Cluster Manager package to build the cluster consists of three steps:Generating a cluster configuration file template based on the cluster topology you wish to deploy.Filling in the generated file with the relevant information.Running the cluster installation based on the completed configuration file.Generating a configuration fileGenerating the configuration file is done using the command:cfy_cluster_managergenerate-config[OPTIONS]Options-o, --output-path- The local path to save the cluster install configuration file to.
Default: ./cfy_cluster_config.yaml--three-nodes- Using a three nodes cluster.--nine-nodes- Using a nine nodes cluster. In case of using an
external DB, Only 6 nodes will need to be provided.--external-db- Using an external DB.-v, --verbose- Show verbose output.-h, --help- Show this help message and exit.NOTE:--three-nodesor--nine-nodesmust be specified, and they cannot be specified together.Filling in the configuration fileGeneral NoteFill in the information according to the comments in the file itself.NOTE!Do not delete anything from the file.NOTE!On RHEL 8, make sure to use the.el8RPM for themanager_rpm_path.Load-balancerAs mentioned before, a load-balancer is not installed as part of the cluster installation.
Theload_balancer_ipvalue is used in the different config.yaml files for the instances' connection.CertificatesIf you wish to use your own certificates:Fill in theca_cert_pathvalue and thecert_pathandkey_pathvalues for each VM (all of them).In case that a VM's certificate's SAN includes the VM host-name, please specify this host-name as the value
of thehostnamekey.Otherwise: Cloudify signed certificates will be generated and used automatically.config.yaml filesIf you wish to use your own config.yaml files for the different instances, you may
do so by specifying their path as the value of theconfig_pathin each one of the instances (all of them).Otherwise, preconfigured config.yaml files will be generated and used automatically.Note: If you use your own config files, you cannot specify the certificates' paths for the different instances.
Moreover, the ldap, external_db, and credentials sections in the configuration file will be ignored.CredentialsIf you wish to use your own credentials, you can specify them in thecredentialssection.Unfilled credentials will be generated and used by the Cloudify Cluster Manager package. The generated credentials
are random.The PostgreSQL password must start with aletter(i.e. a password12345678will cause an error during PostgreSQL installation).WARNING:At the end of the installation, a file namedsecret_credentials_file.yamlwill be created in the current directory.
This file includes the credentials in clear text. Please, remove it after reviewing it or store it in a safe location.Installing a Cloudify clusterNow that the configuration file is completed, we can move on to the cluster installation using the
following command:cfy_cluster_managerinstall[OPTIONS]Options--config-path- The completed cluster configuration file path.
Default: ./cfy_cluster_config.yaml--override- If specified, any previous installation of Cloudify on
the instances will be removed.--validate- Validate the provided configuration file.-v, --verbose- Show verbose output.-h, --help- Show this help message and exit.NOTE:On RHEL 8,beforeinstalling the cluster, add the following required
packages on each machine of the cluster, since the VMs may come without them:sudoyuminstall-yhttps://repository.cloudifysource.org/cloudify/components/libnsl-2.28-189.el8.x86_64.rpm\https://repository.cloudifysource.org/cloudify/components/glibc-2.28-189.el8.x86_64.rpm\https://repository.cloudifysource.org/cloudify/components/glibc-common-2.28-189.el8.x86_64.rpm\https://repository.cloudifysource.org/cloudify/components/glibc-langpack-en-2.28-189.el8.x86_64.rpm\https://repository.cloudifysource.org/cloudify/components/glibc-locale-source-2.28-189.el8.x86_64.rpm--allowerasingRemoving a Cloudify clusterThe created Cloudify cluster can be removed using the following command:cfy_cluster_managerremove[OPTIONS]Options--config-path- The completed cluster configuration file path.
Default: ./cfy_cluster_config.yaml-v, --verbose- Show verbose output.-h, --help- Show this help message and exit.Upgrading a Cloudify clusterThe Cloudify cluster can be upgraded from v5.1.0 to any minor version (5.1.x) using the following command:cfy_cluster_managerupgrade[OPTIONS]Options--config-path- The completed cluster configuration file path.
Default: ./cfy_cluster_config.yaml--upgrade-rpm- Path to a cloudify-manager-install RPM. This can be either a local or remote path.Default:http://repository.cloudifysource.org/cloudify/5.1.3/ga-release/cloudify-manager-install-5.1.3-ga.el7.x86_64.rpm-v, --verbose- Show verbose output.-h, --help- Show this help message and exit.Fault tolerance mechanismsThe Cloudify Cluster Manager package has a few mechanisms to handle errors:The configuration file is validated before it is being used.The connection to each instance is tested before the installation starts.Thecfy_manager installcommand is run usingsystemd-runon the different instances. I.e. if the SSH connection
is interrupted, the installation keeps on running because it's configured as a child process of the init process.In case of a recoverable error during the installation, you can just run thecfy_cluster_manager installcommand again.
The installation process would:Go over the instances and check if they were installed successfully.Once it gets to the failed instance, it would remove the failed installation, and continue the installation from there.In case of an unrecoverable error during the installation, you can run it again using:cfy_manager install --override.This command would:Go over the instances and remove Cloudify from them (including the RPM).Run the installation process from the start.