Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parametrization of cloudify_manager #2546

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/bestpractices/jenkins-plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Jenkins Plugin"
description: "Introduction to Jenkins' Cloudify integration"
description: "Introduction to Jenkins' integration"
weight: 99
alwaysopen: false
---
Expand All @@ -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
Expand Down
22 changes: 11 additions & 11 deletions content/bestpractices/manager_of_managers/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 )

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
4 changes: 2 additions & 2 deletions content/bestpractices/plugin-development.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions content/bestpractices/vmware_docs.md
Original file line number Diff line number Diff line change
@@ -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/
---
Expand Down
4 changes: 2 additions & 2 deletions content/cloudify_manager/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Cloudify Manager"
description = "Cloudify manager installation and maintanance"
title = "Manager"
description = "Manager installation and maintanance"
weight = 25
alwaysopen = false
+++
Expand Down
2 changes: 1 addition & 1 deletion content/cloudify_manager/agents/_index.md
Original file line number Diff line number Diff line change
@@ -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
+++
Expand Down
10 changes: 5 additions & 5 deletions content/cloudify_manager/architecture/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}).

Expand Down Expand Up @@ -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" >}}).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Certificates Overview
description: Go over the Cloudify certificates setup.
description: Go over the certificates setup.
weight: 40
---

Expand Down
6 changes: 3 additions & 3 deletions content/cloudify_manager/architecture/summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Summary"
description = "Cloudify Manager"
description = "Platform Manager"
weight = 10
alwaysopen = false
+++
Expand Down Expand Up @@ -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/" >}})
Expand Down
6 changes: 3 additions & 3 deletions content/cloudify_manager/cloudify_cli/_index.md
Original file line number Diff line number Diff line change
@@ -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 >}}.

Expand Down
Original file line number Diff line number Diff line change
@@ -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
+++
Expand Down
4 changes: 2 additions & 2 deletions content/cloudify_manager/community/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
+++

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Loading