From 45f9fe1717dc8bc5925a2ee74aaf20bda64b89f1 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 23 Feb 2023 10:53:07 -0500 Subject: [PATCH 1/2] Parameterized the files under content_bestpractices For better integration with Wind River System's conductor, replaced or reworked product names with either variables or generic content. --- content/bestpractices/jenkins-plugin.md | 10 ++++----- .../manager_of_managers/_index.md | 22 +++++++++---------- .../deploy_on_mechanism/_index.md | 2 +- .../exposing_submanager_cli.md | 2 +- content/bestpractices/plugin-development.md | 4 ++-- content/bestpractices/vmware_docs.md | 4 ++-- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/content/bestpractices/jenkins-plugin.md b/content/bestpractices/jenkins-plugin.md index e94b81394..dd3f33d3f 100644 --- a/content/bestpractices/jenkins-plugin.md +++ b/content/bestpractices/jenkins-plugin.md @@ -1,6 +1,6 @@ --- title: "Jenkins Plugin" -description: "Introduction to Jenkins' Cloudify integration" +description: "Introduction to Jenkins' integration" weight: 99 alwaysopen: false --- @@ -11,15 +11,15 @@ alwaysopen: false ![Jenkins Plugin]( /images/jenkins/jenkins-plugin.png ) -The Jenkins Plugin for Cloudify, provided with version 5.0.5 onward, allows Jenkins authors -to embed Cloudify functions within jobs and pipelines. +The Jenkins Plugin for {{< param product_name >}}, provided with version 5.0.5 onward, allows Jenkins authors +to embed {{< param product_name >}} functions within jobs and pipelines. ### Plugin contents The plugin provides: -* Discrete build steps for basic Cloudify functions (uploading / deleting blueprints, creating / deleting environments, workflow execution and so forth) -* A standard Jenkins _Build Wrapper_, a convenient enclosure for other build steps that sets up a Cloudify environment before the main steps and deletes the environment afterwards +* Discrete build steps for basic {{< param product_name >}} functions (uploading / deleting blueprints, creating / deleting environments, workflow execution and so forth) +* A standard Jenkins _Build Wrapper_, a convenient enclosure for other build steps that sets up a {{< param product_name >}} environment before the main steps and deletes the environment afterwards * Build steps for integration with other provisioning tools: * Azure ARM * AWS CloudFormation diff --git a/content/bestpractices/manager_of_managers/_index.md b/content/bestpractices/manager_of_managers/_index.md index 85ab74c4e..2ba84b08f 100644 --- a/content/bestpractices/manager_of_managers/_index.md +++ b/content/bestpractices/manager_of_managers/_index.md @@ -7,22 +7,22 @@ abstract: Spire Manager weight: 102 --- -# Using Cloudify as a Manager of Managers (a.k.a MoM or Spire) -![Using Cloudify as a Manager of Managers](/images/mom/spire.png "Using Cloudify as a Manager of Managers") -*Using Cloudify as a Manager of Managers* +# Using {{< param product_name >}} as a Manager of Managers (a.k.a MoM or Spire) +![Using {{< param product_name >}} as a Manager of Managers](/images/mom/spire.png "Using {{< param product_name >}} as a Manager of Managers") +*Using {{< param product_name >}} as a Manager of Managers* -The Cloudify managers of managers (Spire) feature allows control of several managers (*local managers*) from one manager (*Spire*) via the deploy-on feature. +The {{< param product_name >}} managers of managers (Spire) feature allows control of several managers (*local managers*) from one manager (*Spire*) via the deploy-on feature. The deploy-on feature allows users to deploy services on the discovered environments. The deploy-on feature also provides a means to deploy the same service on multiple environments using a single command. Users can group the environments based on location, tagging and filters. The following guide provides a step by step guide on how to install sub managers, add them to a central manager using a discovery mechanism, and deploy an application on multiple managers through a single command. -## 1. Installation of Cloudify Spire Manager +## 1. Installation of {{< param cfy_spire_name >}} Manager -To install the ***MAIN Manager (Spire)***, please refer to the [Cloudify official documentation.](https://docs.cloudify.co/latest/install_maintain/installation/installing-manager/) +To install the ***MAIN Manager (Spire)***, please refer to the [{{< param product_name >}} official documentation.](https://docs.cloudify.co/latest/install_maintain/installation/installing-manager/) -You can also check [Cloudify EC2 Provisioning](https://github.com/cloudify-community/cloudify-catalog/tree/6.4.0-build/cloudify_manager/ec2). It is the package for installing the *Cloudify Manager* on an ec2 AWS instance. +You can also check [{{< param product_name >}} EC2 Provisioning](https://github.com/cloudify-community/cloudify-catalog/tree/6.4.0-build/cloudify_manager/ec2). It is the package for installing the *{{< param cfy_manager_name >}}* on an ec2 AWS instance. ## 2. Installation of sub-managers @@ -40,17 +40,17 @@ First step is to deploy [manager_discovery.yaml](https://github.com/cloudify-com - ***protocol*** - protocol used by sub manager - ***port*** - number of port which sub manager is exposed -[Installation using the Cloudify Management Console]({{< relref "exposing_submanager/exposing_submanager_ui.md" >}}) +[Installation using the {{< param cfy_console_name >}}]({{< relref "exposing_submanager/exposing_submanager_ui.md" >}}) -[Installation using the Cloudify API]({{< relref "exposing_submanager/exposing_submanager_api.md" >}}) +[Installation using the {{< param cfy_api_name >}}]({{< relref "exposing_submanager/exposing_submanager_api.md" >}}) -[Installation using the Cloudify CLI]({{< relref "exposing_submanager/exposing_submanager_cli.md" >}}) +[Installation using the {{< param cfy_api_name >}}]({{< relref "exposing_submanager/exposing_submanager_cli.md" >}}) ### Required secrets To perform correct management, you need to create also a proper [secret](https://docs.cloudify.co/latest/cli/orch_cli/secrets/) about your **all** sub managers in Spire central manager. There are two ways to connect Spire with sub managers: -- _Token_ - contains the proper value of [Cloudify token](https://docs.cloudify.co/latest/cli/orch_cli/tokens/). The token can be created with command ***cfy token create*** +- _Token_ - contains the proper value of [{{< param product_name >}} token](https://docs.cloudify.co/latest/cli/orch_cli/tokens/). The token can be created with command ***cfy token create*** - _User password_ and _username_- contains the value of password and name of the user ![Secrets]( /images/mom/secrets.png ) diff --git a/content/bestpractices/manager_of_managers/deploy_on_mechanism/_index.md b/content/bestpractices/manager_of_managers/deploy_on_mechanism/_index.md index 126829736..704ee1961 100644 --- a/content/bestpractices/manager_of_managers/deploy_on_mechanism/_index.md +++ b/content/bestpractices/manager_of_managers/deploy_on_mechanism/_index.md @@ -27,7 +27,7 @@ Inputs description: - *trust_all* - the value of ***CLOUDIFY_SSL_TRUST_ALL*** (true if the certificate is not valid or for testing purpose) - optional (depends on authentication type): - *cloudify_secret_token* - the name of the secret which contains token value - - *cloudify_password_secret_name* and *cloudify_user_secret_name*- the name of the secret which contains value of the password and the user name of Cloudify user. + - *cloudify_password_secret_name* and *cloudify_user_secret_name*- the name of the secret which contains value of the password and the user name of {{< param product_name >}} user. ## Verification “Deploy on” mechanism To check if deployments are deployed on local managers, follow the example below/ diff --git a/content/bestpractices/manager_of_managers/exposing_submanager/exposing_submanager_cli.md b/content/bestpractices/manager_of_managers/exposing_submanager/exposing_submanager_cli.md index be51e4123..57387a729 100644 --- a/content/bestpractices/manager_of_managers/exposing_submanager/exposing_submanager_cli.md +++ b/content/bestpractices/manager_of_managers/exposing_submanager/exposing_submanager_cli.md @@ -5,7 +5,7 @@ weight: 105 alwaysopen: false --- -#### Installation via Cloudify CLI. +#### Installation via {{< param cfy_cli_name >}}. To proceed with CLI installation, refer to [official documentation](https://docs.cloudify.co/latest/cli/orch_cli/). diff --git a/content/bestpractices/plugin-development.md b/content/bestpractices/plugin-development.md index b4b1e9b06..94cb74f81 100644 --- a/content/bestpractices/plugin-development.md +++ b/content/bestpractices/plugin-development.md @@ -1,5 +1,5 @@ --- -title: "Cloudify Plugin Development: Best Practices" +title: "Plugin Development: Best Practices" description: "Tips and best practices for plugin development" weight: 98 alwaysopen: false @@ -159,7 +159,7 @@ finally: ### Using `causes` with `RecoverableError` / `NonRecoverableError` -When raising one of Cloudify’s exceptions (`RecoverableError` or `NonRecoverableError`), as a result of an underlying exception, you should use the “causes” feature when creating the exception class. This ensures that important troubleshooting data is not lost. +When raising one of {{< param product_name >}}’s exceptions (`RecoverableError` or `NonRecoverableError`), as a result of an underlying exception, you should use the “causes” feature when creating the exception class. This ensures that important troubleshooting data is not lost. For example: diff --git a/content/bestpractices/vmware_docs.md b/content/bestpractices/vmware_docs.md index c3de4a63f..87495cc32 100644 --- a/content/bestpractices/vmware_docs.md +++ b/content/bestpractices/vmware_docs.md @@ -1,8 +1,8 @@ --- -title: Cloudify Solution for the VMware stack +title: Solution for the VMware stack category: Manager Architecture draft: false -abstract: Cloudify Solution for the VMware stack +abstract: Solution for the VMware stack weight: 100 aliases: /manager_architecture/create-deployment-flow/ --- From 325be179ac740063e8d035d43fe059b6c7330597 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 30 May 2023 13:12:55 -0400 Subject: [PATCH 2/2] Parametrization of cloudify_manager Applied parameters to product names and titles to files under the cloudify_manager subdirectory --- content/cloudify_manager/_index.md | 4 +-- content/cloudify_manager/agents/_index.md | 2 +- .../cloudify_manager/architecture/_index.md | 10 +++--- .../high_level_architecture/_index.md | 4 +-- .../security/certificates_overview.md | 2 +- .../cloudify_manager/architecture/summary.md | 6 ++-- .../cloudify_manager/cloudify_cli/_index.md | 6 ++-- .../cloudify_cluster_manager_cli/_index.md | 4 +-- content/cloudify_manager/community/_index.md | 4 +-- .../community/install_and_configure/_index.md | 4 +-- .../install_and_configure/centos_rhel.md | 2 +- .../community/install_and_configure/docker.md | 4 +-- .../community/install_and_configure/helm.md | 6 ++-- .../aio/install_and_configure/_index.md | 8 ++--- .../aio/install_and_configure/activate.md | 2 +- .../premium/aio/install_and_configure/aws.md | 12 +++---- .../aio/install_and_configure/centos_rhel.md | 4 +-- .../aio/install_and_configure/docker.md | 14 ++++---- .../premium/aio/install_and_configure/helm.md | 6 ++-- .../premium/compact/_index.md | 2 +- .../compact/install_and_configure/activate.md | 2 +- .../install_and_configure/cluster_manager.md | 4 +-- .../requirments/capacity_and_planning.md | 2 +- .../premium/compact/requirments/network.md | 2 +- .../compact/requirments/operating_system.md | 4 +-- .../compact/requirments/sizing_guidlines.md | 2 +- .../requirments/software_requirments.md | 2 +- .../compact/requirments/system_processes.md | 2 +- .../premium/compact/upgrade.md | 32 ++++++++--------- .../premium/fully_distributed/_index.md | 6 ++-- .../install_and_configure/activate.md | 2 +- .../install_and_configure/cluster_manager.md | 2 +- .../external_db_and_mq.md | 12 +++---- .../requirments/license_and_certificate.md | 8 ++--- .../fully_distributed/requirments/network.md | 2 +- .../requirments/operating_system.md | 4 +-- .../requirments/sizing_guidlines.md | 2 +- .../requirments/software_requirments.md | 2 +- .../requirments/system_processes.md | 2 +- .../premium/fully_distributed/upgrade.md | 20 +++++------ .../cloudify_manager/premium/helm/_index.md | 26 +++++++------- .../premium/helm/installing-helm-aio.md | 6 ++-- .../premium/helm/installing-helm-aks.md | 4 +-- .../premium/helm/installing-helm-eks.md | 4 +-- .../premium/helm/installing-helm-gke.md | 4 +-- .../premium/helm/installing-helm-worker.md | 34 +++++++++---------- content/cloudify_manager/saas/_index.md | 18 +++++----- 47 files changed, 158 insertions(+), 158 deletions(-) diff --git a/content/cloudify_manager/_index.md b/content/cloudify_manager/_index.md index 7d9615124..da9cb5fed 100644 --- a/content/cloudify_manager/_index.md +++ b/content/cloudify_manager/_index.md @@ -1,6 +1,6 @@ +++ -title = "Cloudify Manager" -description = "Cloudify manager installation and maintanance" +title = "Manager" +description = "Manager installation and maintanance" weight = 25 alwaysopen = false +++ diff --git a/content/cloudify_manager/agents/_index.md b/content/cloudify_manager/agents/_index.md index 03782f385..3346cadd5 100644 --- a/content/cloudify_manager/agents/_index.md +++ b/content/cloudify_manager/agents/_index.md @@ -1,6 +1,6 @@ +++ title = "Agents" -description = "This section covers how to work with Cloudify Agents and the supported OSs, installation, and operation instructions." +description = "This section covers how to work with {{< param product_name >}} Agents and the supported OSs, installation, and operation instructions." weight = 60 alwaysopen = false +++ diff --git a/content/cloudify_manager/architecture/_index.md b/content/cloudify_manager/architecture/_index.md index 5b45d6e5f..2c56233f0 100644 --- a/content/cloudify_manager/architecture/_index.md +++ b/content/cloudify_manager/architecture/_index.md @@ -6,24 +6,24 @@ weight = 10 ## Overview -This section is a collection of information about the architecture and operational characteristics of Cloudify Manager. +This section is a collection of information about the architecture and operational characteristics of {{< param cfy_manager_name >}}. For the most part, documents in this section are not intended as task-oriented instructions. Instead, they are offered as background information to help inform your own proactive administration, maintenance, and architecture practices. -There are 3 options to consume Cloudify Manager, Community, Premium, and SaaS. +There are 3 options to consume {{< param cfy_manager_name >}}, Community, Premium, and SaaS. ## Community -Cloudify Community is an open-source version. Cloudify Manager Community can be installed either as a docker container, on VM (RHEL/CentOS), or on Kubernetes using our Helm Chart. +{{< param product_name >}} Community is an open-source version. {{< param cfy_manager_name >}} Community can be installed either as a docker container, on VM (RHEL/CentOS), or on Kubernetes using our Helm Chart. ## Premium -Cloudify Premium is a commercial version. Cloudify Manager Premium can be installed either as a docker container, on VM (RHEL/CentOS), or on Kubernetes using our Helm Chart. +{{< param product_name >}} Premium is a commercial version. {{< param cfy_manager_name >}} Premium can be installed either as a docker container, on VM (RHEL/CentOS), or on Kubernetes using our Helm Chart. ## SaaS -Cloudify SaaS provides all of the Premium features. It is a hosted Cloudify Manager, so you don’t need to worry about installation, maintenance, and availability. The SaaS is always up to date with the most recent features. +{{< param product_name >}} SaaS provides all of the Premium features. It is a hosted {{< param cfy_manager_name >}}, so you don’t need to worry about installation, maintenance, and availability. The SaaS is always up to date with the most recent features. ## Comparison Matrix {#comparison-matrix} diff --git a/content/cloudify_manager/architecture/high_level_architecture/_index.md b/content/cloudify_manager/architecture/high_level_architecture/_index.md index 225ead685..406f67fae 100644 --- a/content/cloudify_manager/architecture/high_level_architecture/_index.md +++ b/content/cloudify_manager/architecture/high_level_architecture/_index.md @@ -11,7 +11,7 @@ alwaysopen = false * Agents _optional_ * {{< param cfy_console_name >}} -## Cloudify Manager +## {{< param cfy_manager_name >}} The {{< param cfy_manager_name >}} consists of the {{< param product_name >}} code and a set of open-source applications. For an in-depth explanation of these applications, [click here]({{< relref "cloudify_manager/architecture/high_level_architecture/architecture.md" >}}). @@ -44,4 +44,4 @@ For more information about agents, [click here]({{< relref "cloudify_manager/age ## {{< param cfy_console_name >}} -This is a UI interface that easily interacts with Cloudify Manager. For more information, [click here]({{< relref "working_with/console/_index.md" >}}). +This is a UI interface that easily interacts with {{< param cfy_manager_name >}}. For more information, [click here]({{< relref "working_with/console/_index.md" >}}). diff --git a/content/cloudify_manager/architecture/security/certificates_overview.md b/content/cloudify_manager/architecture/security/certificates_overview.md index 02f70b219..df2a6a01a 100644 --- a/content/cloudify_manager/architecture/security/certificates_overview.md +++ b/content/cloudify_manager/architecture/security/certificates_overview.md @@ -1,6 +1,6 @@ --- title: Certificates Overview -description: Go over the Cloudify certificates setup. +description: Go over the certificates setup. weight: 40 --- diff --git a/content/cloudify_manager/architecture/summary.md b/content/cloudify_manager/architecture/summary.md index 3ae75c404..43f896af6 100644 --- a/content/cloudify_manager/architecture/summary.md +++ b/content/cloudify_manager/architecture/summary.md @@ -1,6 +1,6 @@ +++ title = "Summary" -description = "Cloudify Manager" +description = "Platform Manager" weight = 10 alwaysopen = false +++ @@ -64,9 +64,9 @@ To learn more about installing the {{< param product_name >}} fully distributed Note: The above-mentioned section will guide you on how to deploy a distributed cluster manually. {{< param product_name >}} provides an automated flow that simplifies the deployment over 9 existing VMs. To use the Cluster Manager package and automate the cluster deployment flow read: [Cluster Manager Package] ({{< relref "cloudify_manager/premium/fully_distributed/install_and_configure/cluster_manager.md" >}}). {{% /note %}} -## Cloudify on Kubernetes +## {{< param product_name >}} on Kubernetes -The Cloudify platform can be deployed on K8s using the Helm chart. Cloudify creates a stateful pod that will require persistence volume. It can be provisioned as an All-in-One, that contains all three layers (Cloudify Manager, Database, and Message Queue) or deployed as a cluster where the Manager is deployed on a separate pod and PostgreSQL DB or RabbitMQ Message Queue are either deployed on Kubernetes or used as external resources. +The {{< param product_name >}} platform can be deployed on K8s using the Helm chart. {{< param product_name >}} creates a stateful pod that will require persistence volume. It can be provisioned as an All-in-One, that contains all three layers ({{< param cfy_manager_name >}}, Database, and Message Queue) or deployed as a cluster where the Manager is deployed on a separate pod and PostgreSQL DB or RabbitMQ Message Queue are either deployed on Kubernetes or used as external resources. - [Community - AIO]({{< relref "cloudify_manager/premium/helm/" >}}) - [Premium - AIO]({{< relref "cloudify_manager/premium/helm/" >}}) diff --git a/content/cloudify_manager/cloudify_cli/_index.md b/content/cloudify_manager/cloudify_cli/_index.md index 5ac9b6590..65b1ba011 100644 --- a/content/cloudify_manager/cloudify_cli/_index.md +++ b/content/cloudify_manager/cloudify_cli/_index.md @@ -1,11 +1,11 @@ +++ -title = "Cloudify CLI" -description = "Cloudify CLI is a command line client to interact with Cloudify Manager. The section provides all the details to install and setup CFY CLI." +title = "Platform CLI" +description = "Platform CLI is a command line client to interact with platform Manager. The section provides all the details to install and setup CFY CLI." weight = 50 alwaysopen = false +++ -## Installing the Cloudify CLI +## Installing the {{< param product_name >}} CLI To remotely connect to the {{< param cfy_manager_name >}}, you can install the {{< param product_name >}} Command Line Interface (CLI) on a separate host. The {{< param cfy_cli_name >}} includes all of the commands necessary to run any actions on {{< param cfy_manager_name >}}. diff --git a/content/cloudify_manager/cloudify_cluster_manager_cli/_index.md b/content/cloudify_manager/cloudify_cluster_manager_cli/_index.md index 9329baf6c..116572c16 100644 --- a/content/cloudify_manager/cloudify_cluster_manager_cli/_index.md +++ b/content/cloudify_manager/cloudify_cluster_manager_cli/_index.md @@ -1,6 +1,6 @@ +++ -title = "Cloudify Cluster Manager CLI" -description = "Cloudify Cluster Manager CLI is a command line to automate the Cloudify Premium installation on 3 nodes or 9 nodes." +title = "Cluster Manager CLI" +description = "Cluster Manager CLI is a command line to automate the Premium installation on 3 nodes or 9 nodes." weight = 55 alwaysopen = false +++ diff --git a/content/cloudify_manager/community/_index.md b/content/cloudify_manager/community/_index.md index d9d5f0e3e..0c0a5b12b 100644 --- a/content/cloudify_manager/community/_index.md +++ b/content/cloudify_manager/community/_index.md @@ -6,6 +6,6 @@ alwaysopen = false +++ ## Overview -Cloudify's Community version can be installed in All-in-One (AIO) mode only. AIO deployment is based on a single Cloudify box (single VM/Container) running all the Cloudify components, mainly the manager, the database, and the messaging queue. +{{< param product_name >}}'s Community version can be installed in All-in-One (AIO) mode only. AIO deployment is based on a single {{< param product_name >}} box (single VM/Container) running all the {{< param product_name >}} components, mainly the manager, the database, and the messaging queue. -The Cloudify free community version contains a fully functional Cloudify engine and most of the manager capabilities (read about the differences between our Cloudify versions). The community version is available as an rpm, OpenStack image, or as a Docker image. \ No newline at end of file +The {{< param product_name >}} free community version contains a fully functional {{< param product_name >}} engine and most of the manager capabilities (read about the differences between our {{< param product_name >}} versions). The community version is available as an rpm, OpenStack image, or as a Docker image. \ No newline at end of file diff --git a/content/cloudify_manager/community/install_and_configure/_index.md b/content/cloudify_manager/community/install_and_configure/_index.md index 44b286049..eacdf6f3b 100644 --- a/content/cloudify_manager/community/install_and_configure/_index.md +++ b/content/cloudify_manager/community/install_and_configure/_index.md @@ -7,9 +7,9 @@ alwaysopen = false ## Overview -This section covers the Cloudify Manager Community installation. The Cloudify Manager Community is available in All-in-One mode only. +This section covers the {{< param cfy_manager_name >}} Community installation. The {{< param cfy_manager_name >}} Community is available in All-in-One mode only. -The Cloudify Manager Community can be installed: +The {{< param cfy_manager_name >}} Community can be installed: * Docker Container - Docker container can be installed on any virtual machine that run Docker Server. * CentOS/ RHEL - Provides instructions on how to install RPM on CentOS/ RHEL. diff --git a/content/cloudify_manager/community/install_and_configure/centos_rhel.md b/content/cloudify_manager/community/install_and_configure/centos_rhel.md index 00379b662..de67d8c0d 100644 --- a/content/cloudify_manager/community/install_and_configure/centos_rhel.md +++ b/content/cloudify_manager/community/install_and_configure/centos_rhel.md @@ -1,6 +1,6 @@ +++ title = "CentOS/ RHEL" -description = "Install a single All-In-One Cloudify Manager." +description = "Install a single All-In-One Manager." weight = 40 +++ diff --git a/content/cloudify_manager/community/install_and_configure/docker.md b/content/cloudify_manager/community/install_and_configure/docker.md index f42cd387a..2b8813dd0 100644 --- a/content/cloudify_manager/community/install_and_configure/docker.md +++ b/content/cloudify_manager/community/install_and_configure/docker.md @@ -7,13 +7,13 @@ weight = 20 ## Overview The {{< param product_name >}} free community version contains a fully functional {{< param product_name >}} engine & most of the manager capabilities (read about the differences between our [{{< param product_name >}} versions]({{< ref "cloudify_manager/architecture/_index.md#comparison-matrix" >}})). -This section describes how to install and run Cloudify Manager as a Docker container. +This section describes how to install and run {{< param cfy_manager_name >}} as a Docker container. Verify that the target computer meets the [prerequisites]({{< relref "cloudify_manager/community/capacity_and_planning.md" >}}). ## Install -Deploying the Cloudify trial manager as a Docker container is the easiest way to go. This tutorial assumes that you have Docker installed on a local or remote machine. +Deploying the {{< param product_name >}} trial manager as a Docker container is the easiest way to go. This tutorial assumes that you have Docker installed on a local or remote machine. Open your terminal and create/ start the Docker container (requires password). ``` diff --git a/content/cloudify_manager/community/install_and_configure/helm.md b/content/cloudify_manager/community/install_and_configure/helm.md index 4e06bf9b0..2be66fea9 100644 --- a/content/cloudify_manager/community/install_and_configure/helm.md +++ b/content/cloudify_manager/community/install_and_configure/helm.md @@ -8,7 +8,7 @@ alwaysopen: false ## Overview -The Cloudify Manager may be installed to the Kubernetes cluster using our official [Helm chart](https://github.com/cloudify-cosmo/cloudify-helm). +The {{< param cfy_manager_name >}} may be installed to the Kubernetes cluster using our official [Helm chart](https://github.com/cloudify-cosmo/cloudify-helm). ## Prerequisites @@ -19,7 +19,7 @@ The Cloudify Manager may be installed to the Kubernetes cluster using our offici ## Description -It's a Helm chart for Cloudify manager which is: +It's a Helm chart for {{< param cfy_manager_name >}} which is: * Not highly available, has one replica only * Has no persistent volume to survive restarts/ failures @@ -35,4 +35,4 @@ helm install cloudify-manager-aio cloudify-helm/cloudify-manager-aio ## Configure -To understand all available options the AIO Cloudify Manager Helm chart has, please read the [Cloudify AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). +To understand all available options the AIO {{< param cfy_manager_name >}} Helm chart has, please read the [{{< param product_name >}} AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). diff --git a/content/cloudify_manager/premium/aio/install_and_configure/_index.md b/content/cloudify_manager/premium/aio/install_and_configure/_index.md index b1ab1a263..7c6dea324 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/_index.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/_index.md @@ -7,12 +7,12 @@ alwaysopen = false ## Overview -This section covers Cloudify Manager Premium All-in-One installation. +This section covers {{< param cfy_manager_name >}} Premium All-in-One installation. -Cloudify Manager Community can be installed: +{{< param cfy_manager_name >}} Community can be installed: * Docker Container - Can be installed on any virtual machine that runs Docker Server. -* Helm Chart - Provides instruction on how to install the Cloudify Manager Premium on Kubernetes. +* Helm Chart - Provides instruction on how to install the {{< param cfy_manager_name >}} Premium on Kubernetes. * CentOS/ RHEL - Provides instruction how to install RPM on CentOS/ RHEL. -* AWSM AMi - Provides instruction on how to install the Cloudify Manager from AWS Marketplace +* AWSM AMi - Provides instruction on how to install the {{< param cfy_manager_name >}} from AWS Marketplace * QCOW2 - QCOW2 is an OpenStack image. The section provides a details on how to download and provision a virtual machine based on the downloaded image. \ No newline at end of file diff --git a/content/cloudify_manager/premium/aio/install_and_configure/activate.md b/content/cloudify_manager/premium/aio/install_and_configure/activate.md index fca3e3279..b9e8d9e39 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/activate.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/activate.md @@ -1,6 +1,6 @@ --- title: Activate -description: Learn how to activate a Cloudify Premium/Spire license and activate it. +description: Learn how to activate a Premium/Spire license and activate it. weight: 50 --- diff --git a/content/cloudify_manager/premium/aio/install_and_configure/aws.md b/content/cloudify_manager/premium/aio/install_and_configure/aws.md index c60e72f55..6f7bb8e73 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/aws.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/aws.md @@ -6,7 +6,7 @@ alwaysopen = false +++ ## Overview -This page describes the complete setup flow to install Cloudify Manager Premium as an AWS AMI - A fully functional All-In-One Cloudify Manager. +This page describes the complete setup flow to install {{< param cfy_manager_name >}} Manager Premium as an AWS AMI - A fully functional All-In-One {{< param cfy_manager_name >}}. ## Install @@ -26,11 +26,11 @@ Using the standard ec2 instance creation process, the non-default, and important 4. Network Settings - Make sure to select a vpc that matches your requirements, if you want public access to the manager instance, expose it using public VPC & Subnet - Make sure to set **Auto-assign public IP** to `Enable` - - Security Group should be suggested by the AMI; but in general, for Cloudify you need the following ports: + - Security Group should be suggested by the AMI; but in general, for {{< param product_name >}} you need the following ports: - 22 - ssh access - 80 - http access (not a must if the manager is going to accessed by SSL only) - 443 - https access - - 53333 - Internal rest service (required by Cloudify) + - 53333 - Internal rest service (required by {{< param product_name >}}) Click - **`Launch instance`** @@ -42,7 +42,7 @@ A few minutes after the instance is created, the Manager UI should be available For CLI access there are two options: -1. ssh to the running instance using the the following command: (Also good for administrating Cloudify Manager instance) +1. ssh to the running instance using the the following command: (Also good for administrating {{< param cfy_manager_name >}} instance) ``` ssh -i centos@ ``` @@ -51,6 +51,6 @@ ssh -i centos@ ### Advanced configuration and options ### - To connect by ssl to the manager (CLI & UI), configure a DNS record to the instance, or to an LB in front of it, and set an SSL certificate to that record, there are many ways to do so via AWS (e.g. [aws-docs](https://docs.aws.amazon.com/cloudhsm/latest/userguide/ssl-offload-linux.html)) -- To control the ssl option of the Cloudify Manager itself, connect using ssh and follow [this section](https://docs.cloudify.co/latest/cloudify_manager/architecture/security/communication/#ssl-mode-for-external-communication) -- To adjust more options of the Cloudify Manager, run `sudo vi /etc/cloudify/config.yaml`, edit the file according to your needs, and run `cfy_manager configure` to apply the changes. See all the available options [here]({{< relref "cloudify_manager/premium/aio/install_and_configure/centos_rhel.md" >}}) +- To control the ssl option of the {{< param cfy_manager_name >}} itself, connect using ssh and follow [this section](https://docs.cloudify.co/latest/cloudify_manager/architecture/security/communication/#ssl-mode-for-external-communication) +- To adjust more options of the {{< param cfy_manager_name >}}, run `sudo vi /etc/cloudify/config.yaml`, edit the file according to your needs, and run `cfy_manager configure` to apply the changes. See all the available options [here]({{< relref "cloudify_manager/premium/aio/install_and_configure/centos_rhel.md" >}}) - e.g. changing the admin password, setting a hostname, adjusting postgresql/rabbitmq configurations diff --git a/content/cloudify_manager/premium/aio/install_and_configure/centos_rhel.md b/content/cloudify_manager/premium/aio/install_and_configure/centos_rhel.md index 669ce1b66..6ed9bac16 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/centos_rhel.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/centos_rhel.md @@ -1,6 +1,6 @@ +++ title = "CentOS/ RHEL" -description = "Install a single All-In-One Cloudify Manager." +description = "Install a single All-In-One Manager." weight = 30 +++ @@ -75,7 +75,7 @@ restservice: ### Multi-Network Management {#multi-network-management} -The {{< param cfy_manager_name >}} uses [Cloudify Agents]({{< relref "about/manager_architecture/_index.md#cloudify-agents" >}}) to execute tasks and collect information about the resources that it manages. You must specify the {{< param cfy_manager_name >}} IP addresses or DNS names that your agents will use to communicate with it. +The {{< param cfy_manager_name >}} uses [{{< param cfy_agent_name >}}]({{< relref "about/manager_architecture/_index.md#cloudify-agents" >}}) to execute tasks and collect information about the resources that it manages. You must specify the {{< param cfy_manager_name >}} IP addresses or DNS names that your agents will use to communicate with it. {{% note %}} * You cannot configure multi-network management on [{{< param cfy_manager_name >}} images]({{< relref "cloudify_manager/premium/aio/install_and_configure/image.md" >}}). diff --git a/content/cloudify_manager/premium/aio/install_and_configure/docker.md b/content/cloudify_manager/premium/aio/install_and_configure/docker.md index e4c2001f1..477e6e874 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/docker.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/docker.md @@ -6,12 +6,12 @@ alwaysopen = false +++ ## Overview -Cloudify Premium provides a fully functional Premium manager as a Docker container image. This page describes the complete setup flow to install Cloudify Manager Premium as a docker container. +{{< param product_name >}} Premium provides a fully functional Premium manager as a Docker container image. This page describes the complete setup flow to install {{< param cfy_manager_name >}} Premium as a docker container. ## Install -Deploying Cloudify trial manager as a Docker container is the easiest way to go. This tutorial assumes that you have Docker installed on a local or remote machine. +Deploying {{< param product_name >}} trial manager as a Docker container is the easiest way to go. This tutorial assumes that you have Docker installed on a local or remote machine. Open your terminal and create/ start the Docker container. @@ -21,16 +21,16 @@ docker run -d cloudifyplatform/premium-cloudify-manager-aio:latest -p 80:80 Verify that your manager is running by browsing to localhost when running locally, or to the hosting machine IP when the Docker server is remote. -The Cloudify login page should be displayed. +The {{< param product_name >}} login page should be displayed. ## Activate -A Cloudify license is provided to all Cloudify Premium subscribed customers by Cloudify support. Cloudify Premium trial customers receive their trial license via email upon trial request. Request your free 60 days trial at https://cloudify.co/cloudify-premium-download/. +A {{< param product_name >}} license is provided to all {{< param product_name >}} Premium subscribed customers by {{< param product_name >}} support. {{< param product_name >}} Premium trial customers receive their trial license via email upon trial request. Request your free 60 days trial at https://cloudify.co/cloudify-premium-download/. -Once you receive your license activation key, use it to activate your Cloudify Manager. Manager activation (and most other Cloudify actions) can be performed through either Cloudify Management Console (UI) or via Cloudify CLI. In this tutorial, we will demonstrate the usage of the Management Console. +Once you receive your license activation key, use it to activate your {{< param cfy_manager_name >}}. Manager activation (and most other {{< param product_name >}} actions) can be performed through either {{< param product_name >}} Management Console (UI) or via {{< param product_name >}} CLI. In this tutorial, we will demonstrate the usage of the Management Console. -1. Log in to the Cloudify Management Console (as done in step 1 above). username and password are _admin/ admin_. -2. Submit your Cloudify subscription/ trial key. Learn more here. +1. Log in to the {{< param product_name >}} Management Console (as done in step 1 above). username and password are _admin/ admin_. +2. Submit your {{< param product_name >}} subscription/ trial key. Learn more here. ## Configure diff --git a/content/cloudify_manager/premium/aio/install_and_configure/helm.md b/content/cloudify_manager/premium/aio/install_and_configure/helm.md index 362d2b0b9..bcda2b294 100644 --- a/content/cloudify_manager/premium/aio/install_and_configure/helm.md +++ b/content/cloudify_manager/premium/aio/install_and_configure/helm.md @@ -6,7 +6,7 @@ alwaysopen = false +++ ## Overview -The Cloudify Manager may be installed to the Kubernetes cluster using our official [Helm chart](https://github.com/cloudify-cosmo/cloudify-helm). +The {{< param cfy_manager_name >}} may be installed to the Kubernetes cluster using our official [Helm chart](https://github.com/cloudify-cosmo/cloudify-helm). ## Prerequisites @@ -17,7 +17,7 @@ The Cloudify Manager may be installed to the Kubernetes cluster using our offici ## Description -Helm chart for Cloudify manager is: +Helm chart for {{< param cfy_manager_name >}} is: * Not highly available, has one replica only * Has no persistent volume to survive restarts/ failures @@ -33,4 +33,4 @@ helm install cloudify-manager-aio cloudify-helm/cloudify-manager-aio ## Configure -To understand all available options the AIO Cloudify Manager Helm chart has, please read the [Cloudify AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). +To understand all available options the AIO {{< param cfy_manager_name >}} Helm chart has, please read the [{{< param product_name >}} AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). diff --git a/content/cloudify_manager/premium/compact/_index.md b/content/cloudify_manager/premium/compact/_index.md index 1f052d598..91d09925e 100644 --- a/content/cloudify_manager/premium/compact/_index.md +++ b/content/cloudify_manager/premium/compact/_index.md @@ -1,6 +1,6 @@ +++ title = "Compact" -description = "This section covers the requirments, installation, and operation steps for a Compact cluster (3-node cluster). In a Compact cluster each node has 3 layers, Cloudify Manager, PostgreSQL, and RabbitMQ." +description = "This section covers the requirments, installation, and operation steps for a Compact cluster (3-node cluster). In a Compact cluster each node has 3 layers, Manager, PostgreSQL, and RabbitMQ." weight = 20 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/compact/install_and_configure/activate.md b/content/cloudify_manager/premium/compact/install_and_configure/activate.md index 616c6a2ed..d586af718 100644 --- a/content/cloudify_manager/premium/compact/install_and_configure/activate.md +++ b/content/cloudify_manager/premium/compact/install_and_configure/activate.md @@ -1,6 +1,6 @@ --- title: Activate -description: Learn how to activate a Cloudify Premium license and activate it. +description: Learn how to activate a Premium license and activate it. weight: 30 --- diff --git a/content/cloudify_manager/premium/compact/install_and_configure/cluster_manager.md b/content/cloudify_manager/premium/compact/install_and_configure/cluster_manager.md index 79e76c296..1b553fb5a 100644 --- a/content/cloudify_manager/premium/compact/install_and_configure/cluster_manager.md +++ b/content/cloudify_manager/premium/compact/install_and_configure/cluster_manager.md @@ -1,6 +1,6 @@ +++ title = "Automated Install" -description = "The following article will guide you through the different steps of easily installing a Cloudify cluster on either 3 or 9 VMs." +description = "The following article will guide you through the different steps of easily installing a cluster on either 3 or 9 VMs." weight = 10 alwaysopen = false +++ @@ -145,7 +145,7 @@ cfy_cluster_manager upgrade [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. +* `--upgrade-rpm` - Path to a {{< param cfy_manager_name >}} install RPM. This can be either a local or remote path. * `-v, --verbose` - Show verbose output. * `-h, --help` - Show this help message and exit. diff --git a/content/cloudify_manager/premium/compact/requirments/capacity_and_planning.md b/content/cloudify_manager/premium/compact/requirments/capacity_and_planning.md index 7fac45840..01945f1d9 100644 --- a/content/cloudify_manager/premium/compact/requirments/capacity_and_planning.md +++ b/content/cloudify_manager/premium/compact/requirments/capacity_and_planning.md @@ -1,6 +1,6 @@ +++ title = "Capacity and Planning" -description = "The Cloudify Compact Cluster deployment capacity and planning are based on the server and the following recommendations." +description = "The Compact Cluster deployment capacity and planning are based on the server and the following recommendations." weight = 10 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/compact/requirments/network.md b/content/cloudify_manager/premium/compact/requirments/network.md index abd40e7d3..e8b617505 100644 --- a/content/cloudify_manager/premium/compact/requirments/network.md +++ b/content/cloudify_manager/premium/compact/requirments/network.md @@ -24,7 +24,7 @@ The {{< param cfy_manager_name >}} listens on the following ports: |-------|----------------------------------------------------------------------------| | 80 | REST API and UI. This port must be accessible when SSL is not enabled. | | 443 | REST API and UI. This port must be accessible when SSL is enabled. | -| 22 | For remote access to the manager from the Cloudify CLI. (Optional) | +| 22 | For remote access to the manager from the CLI. (Optional) | | 5671 | RabbitMQ. This port must be accessible from agent VMs. | | 8009 | Monitoring service port. | | 53333 | Internal REST communications. This port must be accessible from agent VMs. | diff --git a/content/cloudify_manager/premium/compact/requirments/operating_system.md b/content/cloudify_manager/premium/compact/requirments/operating_system.md index 772fb0222..66e931da4 100644 --- a/content/cloudify_manager/premium/compact/requirments/operating_system.md +++ b/content/cloudify_manager/premium/compact/requirments/operating_system.md @@ -1,9 +1,9 @@ +++ title = "Operating System" -description = "The operating system that is supported for the Cloudify Manager installation." +description = "The operating system that is supported for the Manager installation." weight = 30 alwaysopen = false +++ ## Overview -Cloudify Manager is supported for installation on a 64-bit host with RHEL, CentOS 7.6, and RHEL 8. \ No newline at end of file +{{< param cfy_manager_name >}} is supported for installation on a 64-bit host with RHEL, CentOS 7.6, and RHEL 8. \ No newline at end of file diff --git a/content/cloudify_manager/premium/compact/requirments/sizing_guidlines.md b/content/cloudify_manager/premium/compact/requirments/sizing_guidlines.md index 57bf293df..0bb35fcef 100644 --- a/content/cloudify_manager/premium/compact/requirments/sizing_guidlines.md +++ b/content/cloudify_manager/premium/compact/requirments/sizing_guidlines.md @@ -1,6 +1,6 @@ +++ title = "Sizing Guidelines" -description = "Defining the exact sizing of a Cloudify Manager is based on many variants in the equation. These are the guidelines and insights into how such sizing can be determined." +description = "Defining the exact sizing of a Manager is based on many variants in the equation. These are the guidelines and insights into how such sizing can be determined." weight = 20 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/compact/requirments/software_requirments.md b/content/cloudify_manager/premium/compact/requirments/software_requirments.md index 6981e43e8..42bfd9844 100644 --- a/content/cloudify_manager/premium/compact/requirments/software_requirments.md +++ b/content/cloudify_manager/premium/compact/requirments/software_requirments.md @@ -1,6 +1,6 @@ +++ title = "Software Requirements" -description = "This section reviews the specific software requirements before you install the Cloudify Manager." +description = "This section reviews the specific software requirements before you install the Manager." weight = 50 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/compact/requirments/system_processes.md b/content/cloudify_manager/premium/compact/requirments/system_processes.md index 184d38d41..21ab645f7 100644 --- a/content/cloudify_manager/premium/compact/requirments/system_processes.md +++ b/content/cloudify_manager/premium/compact/requirments/system_processes.md @@ -1,6 +1,6 @@ +++ title = "System Processes" -description = "This section reviews the system processes for the Cloudify Manager environment." +description = "This section reviews the system processes for the Manager environment." weight = 60 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/compact/upgrade.md b/content/cloudify_manager/premium/compact/upgrade.md index 58b9c1b51..3761d1a84 100644 --- a/content/cloudify_manager/premium/compact/upgrade.md +++ b/content/cloudify_manager/premium/compact/upgrade.md @@ -5,19 +5,19 @@ weight = 60 alwaysopen = false +++ -## Upgrading a Cloudify Compact Cluster (3 Nodes) +## Upgrading a {{< param product_name >}} Compact Cluster (3 Nodes) -If the initial cluster installation was done using the Cloudify Cluster Manager, follow this simplified process. -Updating a Cloudify Compact Cluster leveraging the Cloudify Cluster Manager, -you can use the Cloudify Cluster Manager tool to upgrade a compact cluster. +If the initial cluster installation was done using the {{< param product_name >}} Cluster Manager, follow this simplified process. +Updating a {{< param product_name >}} Compact Cluster leveraging the {{< param product_name >}} Cluster Manager, +you can use the {{< param product_name >}} Cluster Manager tool to upgrade a compact cluster. -Upgrade your Cloudify Cluster Manager by running: +Upgrade your {{< param product_name >}} Cluster Manager by running: ``` -sudo yum install -y +sudo yum install -y <{{< param product_name >}} Manager Installation RPM> ``` -On the host that has Cloudify Cluster Manager installed, run: +On the host that has {{< param product_name >}} Cluster Manager installed, run: ``` cfy_cluster_manager upgrade ``` @@ -28,7 +28,7 @@ Optional arguments: --config-path The completed cluster configuration file path. Default: ./cfy_cluster_config.yaml --upgrade-rpm Path to a v6.4.0 cloudify-manager-install RPM. This can be either a local or remote path. -Default: +Default:<{{< param product_name >}} Manager Installation RPM> -v, --verbose Show verbose output ``` @@ -37,12 +37,12 @@ Running this command will automatically run the upgrade procedure on the cluster If the Cluster was manually deployed, please follow this procedure instead: -### Manually Updating a Cloudify Compact Cluster +### Manually Updating a {{< param product_name >}} Compact Cluster -Install the new 6.4 release `cloudify-manager-install` RPM on all 3 nodes of the cluster, by using the command: +Install the new 6.4 release `{{< param product_name >}}-manager-install` RPM on all 3 nodes of the cluster, by using the command: ``` -sudo yum install -y +sudo yum install -y <{{< param product_name >}} Manager Installation RPM> ``` Repeat this step on all 3 nodes. @@ -55,7 +55,7 @@ cfy_manager upgrade -c . Do it one after the other, not in parallel. {{% note %}} -Tip: If you used the cloudify-cluster-manager tool to generate the Cloudify cluster, the path to the DB config file is /etc/cloudify/postgresql-_config.yaml. +Tip: If you used the cloudify-cluster-manager tool to generate the {{< param product_name >}} cluster, the path to the DB config file is /etc/cloudify/postgresql-_config.yaml. {{% /note %}} If the cluster was manually installed, please direct the command to the path of the file you generated. @@ -69,7 +69,7 @@ cfy_manager upgrade -c . Do it one after the other, not in parallel. {{% note %}} -Tip: If you used the cloudify-cluster-manager tool to generate the Cloudify cluster, the path to the RabbitMQ config file is /etc/cloudify/rabbitmq-_config.yaml. If the cluster was manually installed, please direct the command to the path of the file you generated. +Tip: If you used the {{< param product_name >}}-cluster-manager tool to generate the {{< param product_name >}} cluster, the path to the RabbitMQ config file is /etc/cloudify/rabbitmq-_config.yaml. If the cluster was manually installed, please direct the command to the path of the file you generated. {{% /note %}} On each one of the cluster nodes, run: @@ -80,12 +80,12 @@ cfy_manager upgrade -c Do it one after the other, not in parallel. {{% note %}} -Tip: If you used the cloudify-cluster-manager tool to generate the Cloudify cluster, the path to the manager config file is /etc/cloudify/manager-_config.yaml. If the cluster was manually installed, please direct the command to the path of the file you generated. +Tip: If you used the {{< param product_name >}}-cluster-manager tool to generate the {{< param product_name >}} cluster, the path to the manager config file is /etc/cloudify/manager-_config.yaml. If the cluster was manually installed, please direct the command to the path of the file you generated. {{% /note %}} -If Cloudify agents are used in your deployments, run the following command from just one of the cluster nodes: +If {{< param product_name >}} agents are used in your deployments, run the following command from just one of the cluster nodes: ``` cfy agents install ``` -When opening the Cloudify Management Console after the upgrade, you might see “This page is empty”, this happens because of cached data. To solve this, press CTRL + Shift + R. \ No newline at end of file +When opening the {{< param product_name >}} Management Console after the upgrade, you might see “This page is empty”, this happens because of cached data. To solve this, press CTRL + Shift + R. \ No newline at end of file diff --git a/content/cloudify_manager/premium/fully_distributed/_index.md b/content/cloudify_manager/premium/fully_distributed/_index.md index f8efb1e85..03921db4d 100644 --- a/content/cloudify_manager/premium/fully_distributed/_index.md +++ b/content/cloudify_manager/premium/fully_distributed/_index.md @@ -1,15 +1,15 @@ +++ title = "Fully Distributed" -description = "This section covers the requirments, installation and operation step for Fully Distributed cluster (9 nodes cluster). In Fully Distributed cluster Cloudify Manager is installed on 3 node, PostgreSQL deployed on 3 nodes, and RabbitMQ deployed on 3 nodes." +description = "This section covers the requirments, installation and operation step for Fully Distributed cluster (9 nodes cluster). In Fully Distributed cluster Manager is installed on 3 node, PostgreSQL deployed on 3 nodes, and RabbitMQ deployed on 3 nodes." weight = 30 alwaysopen = false +++ -## Cloudify Cluster Architecture +## {{< param product_name >}} Cluster Architecture ![{{< param product_name >}}_Cluster]( /images/cluster/cluster-architecture.png ) -Cloudify Manager 6.4 clusters are composed of three separate services that construct the entire {{< param product_name >}} solution: + {{< param cfy_manager_name >}} 6.4 clusters are composed of three separate services that construct the entire {{< param product_name >}} solution: 1. {{< param product_name >}} Management Service – The Management service embeds the {{< param product_name >}} workers framework, the REST API, the user interface infrastructure and other backend services. diff --git a/content/cloudify_manager/premium/fully_distributed/install_and_configure/activate.md b/content/cloudify_manager/premium/fully_distributed/install_and_configure/activate.md index d597ef000..a8ab6b544 100644 --- a/content/cloudify_manager/premium/fully_distributed/install_and_configure/activate.md +++ b/content/cloudify_manager/premium/fully_distributed/install_and_configure/activate.md @@ -1,6 +1,6 @@ --- title: Activate -description: Learn how to activate a Cloudify Premium/ Spire license and activate it. +description: Learn how to activate a Premium/ Spire license and activate it. weight: 30 --- diff --git a/content/cloudify_manager/premium/fully_distributed/install_and_configure/cluster_manager.md b/content/cloudify_manager/premium/fully_distributed/install_and_configure/cluster_manager.md index c0541476c..659770405 100644 --- a/content/cloudify_manager/premium/fully_distributed/install_and_configure/cluster_manager.md +++ b/content/cloudify_manager/premium/fully_distributed/install_and_configure/cluster_manager.md @@ -1,6 +1,6 @@ +++ title = "Automated Install" -description = "The following article will guide you through the different steps of easily installing a Cloudify cluster on either three or nine VMs." +description = "The following article will guide you through the different steps of easily installing a cluster on either three or nine VMs." weight = 10 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/fully_distributed/install_and_configure/external_db_and_mq.md b/content/cloudify_manager/premium/fully_distributed/install_and_configure/external_db_and_mq.md index 3c77c6725..94f33a98a 100644 --- a/content/cloudify_manager/premium/fully_distributed/install_and_configure/external_db_and_mq.md +++ b/content/cloudify_manager/premium/fully_distributed/install_and_configure/external_db_and_mq.md @@ -1,6 +1,6 @@ +++ title = "External DB and MQ" -description = "A guide for installing the Cloudify cluster, the user can use the external PostgreSQL database and RabbitMQ." +description = "A guide for installing the luster, the user can use the external PostgreSQL database and RabbitMQ." weight = 30 alwaysopen = false +++ @@ -127,8 +127,8 @@ services. Make sure you read the comments provided and follow them. manager: security: ssl_enabled: true - admin_password: '' - cloudify_license_path: '' + admin_password: '}}>' + cloudify_license_path: '}} license file>' rabbitmq: username: '' @@ -138,7 +138,7 @@ rabbitmq: ca_path: '' # Set this to true if the RabbitMQ is an external service. This will result in the RabbitMQ - # service not being internally-monitored by the Cloudify cluster status reporter. + # service not being internally-monitored by the {{< param product_name >}} cluster status reporter. is_external: true # In case the connection to the RabbitMQ instance uses one IP address, @@ -173,7 +173,7 @@ postgresql_client: host: localhost # Server user name (server_username), password (server_password), - # and DB (server_db_name) to use when connecting to the database for Cloudify + # and DB (server_db_name) to use when connecting to the database for {{< param product_name >}} # DB initialization and population. # # If your database is an Azure DBaaS instance, you must set 'server_username' @@ -186,7 +186,7 @@ postgresql_client: server_username: postgres server_password: '' - # Cloudify DB name, user name and password to be created. + # {{< param product_name >}} DB name, user name and password to be created. # # The following apply if your database is an Azure DBaaS instance: # diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/license_and_certificate.md b/content/cloudify_manager/premium/fully_distributed/requirments/license_and_certificate.md index d88edcce1..88a32a65c 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/license_and_certificate.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/license_and_certificate.md @@ -1,18 +1,18 @@ +++ title = "License and Certificates" -description = "Details on licenses and certificates to be obtain to run Cloudify Manager" +description = "Details on licenses and certificates to be obtain to run the Manager" weight = 9 alwaysopen = false +++ ## Overview -To fully run Cloudify Manager you'll need a license and certificate. +To fully run {{< param cfy_manager_name >}} you'll need a license and certificate. ## License File -To deploy Cloudify Manager Premium you'll need a valid license. You can request a trial with a 60-day license through the link. +To deploy {{< param cfy_manager_name >}} Premium you'll need a valid license. You can request a trial with a 60-day license through the link. ## TLS Certificates and Private Keys -The Cloudify Manager requires TLS certificates and private keys. Follow cloudify_manager/architecture/security/certificates.md for more details. \ No newline at end of file +The {{< param cfy_manager_name >}} requires TLS certificates and private keys. Follow cloudify_manager/architecture/security/certificates.md for more details. \ No newline at end of file diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/network.md b/content/cloudify_manager/premium/fully_distributed/requirments/network.md index 1cbf76645..eb3407b14 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/network.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/network.md @@ -26,7 +26,7 @@ The {{< param cfy_manager_name >}} listens on the following ports: |-------|----------------------------------------------------------------------------| | 80 | REST API and UI. This port must be accessible when SSL is not enabled. | | 443 | REST API and UI. This port must be accessible when SSL is enabled. | -| 22 | For remote access to the manager from the Cloudify CLI. (Optional) | +| 22 | For remote access to the manager from the {{< param cfy_api_name >}}. (Optional) | | 5671 | RabbitMQ. This port must be accessible from agent VMs. | | 8009 | Monitoring service port. | | 53333 | Internal REST communications. This port must be accessible from agent VMs. | diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/operating_system.md b/content/cloudify_manager/premium/fully_distributed/requirments/operating_system.md index 5e4b83393..68f9b8616 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/operating_system.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/operating_system.md @@ -1,9 +1,9 @@ +++ title = "Operating System" -description = "The operating system that is supported for the Cloudify Manager installation." +description = "The operating system that is supported for the Manager installation." weight = 30 alwaysopen = false +++ ## Overview -Cloudify Manager is supported for installation on a 64-bit host with RHEL/ CentOS 7.6 and RHEL 8. \ No newline at end of file +{{< param cfy_manager_name >}} is supported for installation on a 64-bit host with RHEL/ CentOS 7.6 and RHEL 8. \ No newline at end of file diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/sizing_guidlines.md b/content/cloudify_manager/premium/fully_distributed/requirments/sizing_guidlines.md index 5dd5a690e..db5896393 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/sizing_guidlines.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/sizing_guidlines.md @@ -1,6 +1,6 @@ +++ title = "Sizing Guidelines" -description = "Defining the exact sizing of a Cloudify Manager is based on many variants in the equation. These are the guidelines and insights into how such sizing can be determined." +description = "Defining the exact sizing of a Manager is based on many variants in the equation. These are the guidelines and insights into how such sizing can be determined." weight = 20 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/software_requirments.md b/content/cloudify_manager/premium/fully_distributed/requirments/software_requirments.md index 3835a9e62..625f935d1 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/software_requirments.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/software_requirments.md @@ -1,6 +1,6 @@ +++ title = "Software Requirements" -description = "This section reviews the specific software requirements before you install the Cloudify Manager." +description = "This section reviews the specific software requirements before you install the Manager." weight = 50 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/fully_distributed/requirments/system_processes.md b/content/cloudify_manager/premium/fully_distributed/requirments/system_processes.md index 4404ff717..3e9935219 100644 --- a/content/cloudify_manager/premium/fully_distributed/requirments/system_processes.md +++ b/content/cloudify_manager/premium/fully_distributed/requirments/system_processes.md @@ -1,6 +1,6 @@ +++ title = "System Processes" -description = "This section reviews the system processes for the Cloudify Manager environment." +description = "This section reviews the system processes for the Manager environment." weight = 60 alwaysopen = false +++ diff --git a/content/cloudify_manager/premium/fully_distributed/upgrade.md b/content/cloudify_manager/premium/fully_distributed/upgrade.md index ca05ac281..ecaf0cba4 100644 --- a/content/cloudify_manager/premium/fully_distributed/upgrade.md +++ b/content/cloudify_manager/premium/fully_distributed/upgrade.md @@ -5,23 +5,23 @@ weight = 80 alwaysopen = false +++ -## Upgrading a Cloudify Fully Distributed Cluster (9 Nodes) +## Upgrading a {{< param product_name >}} Fully Distributed Cluster (9 Nodes) -If the initial cluster installation was done using the Cloudify Cluster Manager, follow this simplified process. -Updating a Cloudify Fully Distributed Cluster leveraging the Cloudify Cluster Manager -you can use the Cloudify Cluster Manager tool to upgrade a fully distributed cluster. +If the initial cluster installation was done using the {{< param product_name >}} Cluster Manager, follow this simplified process. +Updating a {{< param product_name >}} Fully Distributed Cluster leveraging the {{< param product_name >}} Cluster Manager +you can use the {{< param product_name >}} Cluster Manager tool to upgrade a fully distributed cluster. -Upgrade your Cloudify Cluster Manager by running: +Upgrade your {{< param product_name >}} Cluster Manager by running: ``` sudo yum install -y ``` -On the host that has Cloudify Cluster Manager installed, run cfy_cluster_manager upgrade. +On the host that has {{< param product_name >}} Cluster Manager installed, run cfy_cluster_manager upgrade. Optional Arguments: ``` --config-path The completed cluster configuration file path. Default: ./cfy_cluster_config.yaml --upgrade-rpm Path to a v6.1.0 cloudify-manager-install RPM. This can be either a local or remote path. -Default: +Default: <{{< param product_name >}} Manager Installation RPM> -v, --verbose Show verbose output Running this command will automatically run the upgrade procedure on the cluster. @@ -33,7 +33,7 @@ Manually updating a Fully Distributed Cluster Update steps: Install the new 6.1.0 cloudify-manager-install RPM on all the cluster nodes, by using the command: ``` -sudo yum install -y +sudo yum install -y <{{< param product_name >}} Manager Installation RPM> ``` Repeat this step on all 9 nodes. @@ -60,9 +60,9 @@ cfy_manager upgrade Do it one after the other, not in parallel. -If Cloudify agents are used in your deployments, run the following command from just one of the manager nodes: +If {{< param product_name >}} agents are used in your deployments, run the following command from just one of the manager nodes: ``` cfy agents install ``` -When opening the Cloudify Management Console after the upgrade, you might see “This page is empty”, this happens because of cached data. To solve this, press CTRL + Shift + R. \ No newline at end of file +When opening the {{< param product_name >}} Management Console after the upgrade, you might see “This page is empty”, this happens because of cached data. To solve this, press CTRL + Shift + R. \ No newline at end of file diff --git a/content/cloudify_manager/premium/helm/_index.md b/content/cloudify_manager/premium/helm/_index.md index 97dce27ac..2e14a1982 100644 --- a/content/cloudify_manager/premium/helm/_index.md +++ b/content/cloudify_manager/premium/helm/_index.md @@ -1,7 +1,7 @@ --- layout: bt_wiki title: Helm -description: Deploy a Cloudify Manager to Kubernetes with a helm chart. +description: Deploy a Manager to Kubernetes with a helm chart. category: Installation draft: false weight: 40 @@ -9,8 +9,8 @@ weight: 40 ## Overview -The Cloudify Manager may be installed to a Kubernetes cluster using our official [helm chart](https://github.com/cloudify-cosmo/cloudify-helm). -You have two options for installation: AIO helm chart and Cloudify manager worker helm chart, to better understand each option read about it below. +The {{< param cfy_manager_name >}} may be installed to a Kubernetes cluster using our official [helm chart](https://github.com/cloudify-cosmo/cloudify-helm). +You have two options for installation: AIO helm chart and {{< param product_name >}} manager worker helm chart, to better understand each option read about it below. ## Prerequisites {{% note title="Prerequisites" %}} @@ -18,17 +18,17 @@ You have two options for installation: AIO helm chart and Cloudify manager worke * Installed [Helm package manager](https://helm.sh/) {{% /note %}} -# Cloudify Manager AIO Helm Chart ( Community Version ) +# {{< param cfy_manager_name >}} AIO Helm Chart ( Community Version ) ## Description -A Helm chart for Cloudify Manager is: +A Helm chart for {{< param cfy_manager_name >}} is: * Not highly available, has one replica only. * Has no persistent volume to survive restarts or failures. * Has all components on board (as part of docker container): Message Broker and DB part of it. -**This is the best and simplest way to make yourself familiar with Cloudify, running a Cloudify Manager AIO in a matter of minutes.** +**This is the best and simplest way to make yourself familiar with {{< param product_name >}}, running a {{< param cfy_manager_name >}} AIO in a matter of minutes.** ## Installation ```bash @@ -36,21 +36,21 @@ helm repo add cloudify-helm https://cloudify-cosmo.github.io/cloudify-helm helm install cloudify-manager-aio cloudify-helm/cloudify-manager-aio ``` -To understand all available options AIO, the Cloudify Manager chart has, please read [Cloudify AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). +To understand all available options AIO, the {{< param cfy_manager_name >}} chart has, please read [{{< param product_name >}} AIO Helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-aio.md" >}}). -## Cloudify Manager Worker Helm Chart ( Premium Version ) +## {{< param cfy_manager_name >}} Worker Helm Chart ( Premium Version ) ### Description -A Helm chart for Cloudify Manager is: +A Helm chart for {{< param cfy_manager_name >}} is: * Highly available, can be deployed with multiple replicas, available only when used with NFS Volume. ( Tested with EFS of AWS, FIlestore of GCP, Azure File Storage) * Use persistent volume to survive restarts or failures. * Use external DB (postgress), which may be deployed via public Helm chart of Bitnami: https://github.com/bitnami/charts/tree/master/bitnami/postgresql * Use external Message Brokes (rabbitMQ), which may be deployed via public Helm chart of Bitnami: https://github.com/bitnami/charts/tree/master/bitnami -This is how the setup looks after it's deployed to 'cfy-example' namespace (it's possible to have multiple replicas (pods) of cloudify manager): +This is how the setup looks after it's deployed to 'cfy-example' namespace (it's possible to have multiple replicas (pods) of {{< param cfy_manager_name >}}): ![cfy-manager](/images/helm/cfy-example.png) @@ -60,12 +60,12 @@ This is how the setup looks after it's deployed to 'cfy-example' namespace (it's 2. Deployment of Message Broker (RabbitMQ). -3. Deployment of Cloudify Manager worker. +3. Deployment of {{< param cfy_manager_name >}} worker. -You need to deploy DB and Message Broker before deploying Cloudify Manager worker. +You need to deploy DB and Message Broker before deploying {{< param cfy_manager_name >}} worker. -To better understand how to install and configure Cloudify Manager worker setup please read [Cloudify Manager worker helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-worker.md" >}}) +To better understand how to install and configure {{< param cfy_manager_name >}} worker setup please read [{{< param cfy_manager_name >}} worker helm chart]({{< relref "cloudify_manager/premium/helm/installing-helm-worker.md" >}}) ## Deployment Examples diff --git a/content/cloudify_manager/premium/helm/installing-helm-aio.md b/content/cloudify_manager/premium/helm/installing-helm-aio.md index c6bb3dce5..6e7e8e663 100644 --- a/content/cloudify_manager/premium/helm/installing-helm-aio.md +++ b/content/cloudify_manager/premium/helm/installing-helm-aio.md @@ -1,12 +1,12 @@ --- layout: bt_wiki title: All-in-One -description: Deploy a Cloudify Manager AIO to Kubernetes with a helm chart. +description: Deploy a Manager AIO to Kubernetes with a helm chart. category: Installation draft: false weight: 10 --- -## Cloudify Manager AIO Helm Chart (Community Version) +## {{< param cfy_manager_name >}} AIO Helm Chart (Community Version) ### Description @@ -16,7 +16,7 @@ A Helm chart for Cloudify Manager is: * Has no persistent volume to survive restarts/failures. * Has all components on board (as part of docker container): Message Broker and DB part of it. -**This is the best and simplest way to make yourself familiar with Cloudify, running a Cloudify Manager AIO in a matter of minutes.** +**This is the best and simplest way to make yourself familiar with {{< param product_name >}}, running a {{< param cfy_manager_name >}} AIO in a matter of minutes.** ### Installation diff --git a/content/cloudify_manager/premium/helm/installing-helm-aks.md b/content/cloudify_manager/premium/helm/installing-helm-aks.md index 31411ef8c..1d22714ac 100644 --- a/content/cloudify_manager/premium/helm/installing-helm-aks.md +++ b/content/cloudify_manager/premium/helm/installing-helm-aks.md @@ -1,12 +1,12 @@ --- layout: bt_wiki title: Azure AKS -description: Deployment to Azure (AKS) of Highly Available Cloudify manager worker using the helm chart. +description: Deployment to Azure (AKS) of Highly Available manager worker using the helm chart. category: Installation draft: false weight: 20 --- -## Deployment to Azure of Highly Available Cloudify Manager Worker ( Premium Version ) +## Deployment to Azure of Highly Available {{< param cfy_manager_name >}} Worker ( Premium Version ) ### Provision AKS Cluster diff --git a/content/cloudify_manager/premium/helm/installing-helm-eks.md b/content/cloudify_manager/premium/helm/installing-helm-eks.md index a0b0bea51..a5833cb6a 100644 --- a/content/cloudify_manager/premium/helm/installing-helm-eks.md +++ b/content/cloudify_manager/premium/helm/installing-helm-eks.md @@ -1,12 +1,12 @@ --- layout: bt_wiki title: AWS EKS -description: Deployment to AWS (EKS) of Highly Available Cloudify manager worker using the helm chart. +description: Deployment to AWS (EKS) of Highly Available manager worker using the helm chart. category: Installation draft: false weight: 30 --- -## Deployment to AWS of Highly Available Cloudify Manager Worker (Premium Version) +## Deployment to AWS of Highly Available {{< param cfy_manager_name >}} Worker (Premium Version) ### Provision EKS Cluster diff --git a/content/cloudify_manager/premium/helm/installing-helm-gke.md b/content/cloudify_manager/premium/helm/installing-helm-gke.md index d2dfd1a35..684fa9cfd 100644 --- a/content/cloudify_manager/premium/helm/installing-helm-gke.md +++ b/content/cloudify_manager/premium/helm/installing-helm-gke.md @@ -1,12 +1,12 @@ --- layout: bt_wiki title: GCP GKE -description: Deployment to Google (GKE) of Highly Available Cloudify manager worker using the helm chart. +description: Deployment to Google (GKE) of Highly Available manager worker using the helm chart. category: Installation draft: false weight: 40 --- -## Deployment to GCP of Highly Available Cloudify Manager Worker (Premium Version) +## Deployment to GCP of Highly Available {{< param cfy_manager_name >}} Worker (Premium Version) ### Provision GKE Cluster diff --git a/content/cloudify_manager/premium/helm/installing-helm-worker.md b/content/cloudify_manager/premium/helm/installing-helm-worker.md index 63d88e1ca..7fd76ce67 100644 --- a/content/cloudify_manager/premium/helm/installing-helm-worker.md +++ b/content/cloudify_manager/premium/helm/installing-helm-worker.md @@ -1,23 +1,23 @@ --- layout: bt_wiki -title: Cloudify Manager Worker -description: Deploy a Cloudify Manager Worker to Kubernetes with a helm chart. +title: Manager Worker +description: Deploy a Manager Worker to Kubernetes with a helm chart. category: Installation draft: false weight: 50 --- -## Cloudify Manager Worker Helm Chart (Premium Version) +## {{< param cfy_manager_name >}} Worker Helm Chart (Premium Version) ### Description -A Helm chart for Cloudify Manager is: +A Helm chart for {{< param cfy_manager_name >}} is: * Is highly available, can be deployed with multiple replicas. (available only when used NFS like Storage file system) * Uses persistent volume to survive restarts or failures. * Uses external DB (postgress), which may be deployed via public Helm chart of Bitnami: https://github.com/bitnami/charts/tree/master/bitnami/postgresql * Uses external Message Brokes (RabbitMQ), which may be deployed via public Helm chart of Bitnami: https://github.com/bitnami/charts/tree/master/bitnami -This is how the setup looks after it's deployed to 'cfy-example' namespace (it's possible to have multiple replicas (pods) of cloudify manager): +This is how the setup looks after it's deployed to 'cfy-example' namespace (it's possible to have multiple replicas (pods) of {{< param cfy_manager_name >}}): ![cfy-manager](/images/helm/cfy-example.png) @@ -31,7 +31,7 @@ This is how the setup looks after it's deployed to 'cfy-example' namespace (it's * [AKS on Azure]({{< relref "cloudify_manager/premium/helm/installing-helm-aks.md" >}}) * [GKE on GCP]({{< relref "cloudify_manager/premium/helm/installing-helm-gke.md" >}}) * Sufficient Kubernetes node [Minimum Requirements](https://docs.cloudify.co/latest/install_maintain/installation/prerequisites/) -* Cloudify Premium valid license (for Premium version) +* {{< param product_name >}} Premium valid license (for Premium version) ### How to create and deploy such a setup? @@ -41,7 +41,7 @@ This is how the setup looks after it's deployed to 'cfy-example' namespace (it's 3. [Deployment of Message Broker (RabbitMQ).](#install-rabbitmqbitnami-to-kubernetes-cluster-with-helm) -4. [Deployment of Cloudify Manager worker.](#install-cloudify-manager-worker) +4. [Deployment of {{< param cfy_manager_name >}} worker.](#install-cloudify-manager-worker) 5. [(Optional) Ensure UI access to the manager upon installation](#optional-ensure-ui-access-to-the-manager-upon-installation) @@ -51,12 +51,12 @@ This is how the setup looks after it's deployed to 'cfy-example' namespace (it's 8. [Uninstallation of Helm charts](#uninstallation) -**You need to deploy DB and Message Broker before deploying Cloudify manager worker.** +**You need to deploy DB and Message Broker before deploying {{< param product_name >}} manager worker.** ### Generate certificates and add as secret to k8s -**SSL certificate must be provided to secure communications between the Cloudify Manager and Posrgress/RabbitMQ:** +**SSL certificate must be provided to secure communications between the {{< param cfy_manager_name >}} and Posrgress/RabbitMQ:** * ca.crt (to sign other certificates) @@ -64,7 +64,7 @@ This is how the setup looks after it's deployed to 'cfy-example' namespace (it's * tls.crt -#### Option 1: Create certificates using the community cloudify manager docker container +#### Option 1: Create certificates using the Community {{< param cfy_manager_name >}} docker container ```bash $ docker pull cloudifyplatform/community-cloudify-manager-aio:latest @@ -227,9 +227,9 @@ Install RabbitMQ with `rabbitmq-values.yaml` with pinned version: $ helm install rabbitmq bitnami/rabbitmq -f ./cloudify-manager-worker/external/rabbitmq-values.yaml --version 8.29.0 -n NAMESPACE ``` -### Install Cloudify Manager Worker +### Install {{< param cfy_manager_name >}} Worker -#### Create configMap with premium license - required if using Cloudify premium version +#### Create configMap with premium license - required if using {{< param product_name >}} premium version Create `license.yaml` file and populate it with license data * American/British English accepted, but must be alligned across all 'license/licence' strings (values/configMaps): @@ -337,10 +337,10 @@ ingress: enabled: true secretName: cfy-secret-name ``` -**HTTP/ HTTPS options will expose Cloudify Manager UI on a URL matching the `host` value** +**HTTP/ HTTPS options will expose {{< param cfy_manager_name >}} UI on a URL matching the `host` value** #### **[OPTION 2]** -Skip Ingress and expose the Cloudify Manager service using LoadBalancer: +Skip Ingress and expose the {{< param cfy_manager_name >}} service using LoadBalancer: **HTTP** @@ -362,7 +362,7 @@ That will create a load balancer depending on your K8S infrastructure (e.g. EKS ```bash kubectl describe svc/cloudify-manager-worker -n NAMESPACE | grep Ingress ``` -**The value of the ingress will be the UI URL of the Cloudify Manager.** +**The value of the ingress will be the UI URL of the {{< param cfy_manager_name >}}.** **HTTPS** * To secure the site with SSL you can update the load balancer configuration to utilize an SSL Certificate @@ -374,9 +374,9 @@ $ helm install cloudify-manager-worker cloudify-helm/cloudify-manager-worker -f ``` ### Configuration Options of cloudify-manager-worker values.yaml Edit the values file in `./cloudify-manager-worker/values.yaml` according to your preferences: -#### Upgrade Cloudify Manager Worker: +#### Upgrade {{< param cfy_manager_name >}} Worker: -To upgrade Cloudify Manager use `helm upgrade`. +To upgrade {{< param cfy_manager_name >}} use `helm upgrade`. For example to change to newer version (e.g. from 6.2.0 to 6.3.0 in this example) diff --git a/content/cloudify_manager/saas/_index.md b/content/cloudify_manager/saas/_index.md index cac8d0b62..8f796701f 100644 --- a/content/cloudify_manager/saas/_index.md +++ b/content/cloudify_manager/saas/_index.md @@ -1,6 +1,6 @@ +++ title = "SaaS" -description = "Overview of how to sign up for the Cloudify SaaS." +description = "Overview of how to sign up for the SaaS." weight = 40 alwaysopen = false +++ @@ -8,19 +8,19 @@ alwaysopen = false ## Overview -Cloudify as a Service is the fastest and easiest way to try Cloudify. You will get access to the Cloudify trial managed service which is hosted and managed by Cloudify. Follow the instructions on this page to get your trial account provisioned and gain access to our trial service. +{{< param product_name >}} as a Service is the fastest and easiest way to try {{< param product_name >}}. You will get access to the {{< param product_name >}} trial managed service which is hosted and managed by {{< param product_name >}}. Follow the instructions on this page to get your trial account provisioned and gain access to our trial service. -Please note that while the Cloudify service requires no deployment or hardware, if you wish to gain the most from your trial you will need access to some cloud infrastructure (e.g. AWS, Azure, GCP) to integrate with and run your test workloads. +Please note that while the {{< param product_name >}} service requires no deployment or hardware, if you wish to gain the most from your trial you will need access to some cloud infrastructure (e.g. AWS, Azure, GCP) to integrate with and run your test workloads. -## Step 1: Request a Cloudify as a Service Trial Account +## Step 1: Request a {{< param product_name >}} as a Service Trial Account -To start using Cloudify as a Service, a dedicated account must be created for you. If you already requested an account and received the details via email please continue to step 2. +To start using {{< param product_name >}} as a Service, a dedicated account must be created for you. If you already requested an account and received the details via email please continue to step 2. -Request your Cloudify trial account [here](https://cloudify.co/download/). +Request your {{< param product_name >}} trial account [here](https://cloudify.co/download/). -Once you submit the account request form, your request is immediately processed by our system and you should expect an email from the Cloudify team within minutes. Your email will contain an access link to your environment as well as other registration information. +Once you submit the account request form, your request is immediately processed by our system and you should expect an email from the {{< param product_name >}} team within minutes. Your email will contain an access link to your environment as well as other registration information. -## Step 2: Activate your Cloudify Trial and Login +## Step 2: Activate your {{< param product_name >}} Trial and Login Follow the link in your email to your dedicated trial management page. This page shares the account provisioning progress, the trial remaining time, and login information (which is also available in the email you received). @@ -33,7 +33,7 @@ Once initialization is complete, the page content will automatically refresh and - A link to your trial manager login page - Your initial login credentials -Follow the link. Cloudify login page should be displayed. +Follow the link. {{< param product_name >}} login page should be displayed. ![login-page.png]( /images/ui/pages/login-page.png )