This module aims at facilitating the users in creating a standard set of autopilot files for their project. Let us see how to use this module, and also about functions of cleofy from the upcoming topics.
The help command is a brief user manual that facilitates the users to get aware regarding the usage, methodologies of handling this module to perform different functions. It also lists outs the alternative parameters that can be used in declarations. It highlights the syntax example for using and accessing different functions under cleofy.
The command used for declaring help option under cleofy is shown below,
ptconfigure cleofy help
The syntax for declaring the help command is not case sensitive which is an added advantage. The following screenshot visualize you about the help command under cleofy.
kevell@corp:/# ptconfigure cleofy help
******************************
This command is part of a default Module Core and provides you with a method by which you can create a standard set of Autopilot files for your project from the command line.
Cleofy, cleofy
- list
List all of the autopilot files in your build/config/ptconfigure/autopilots
example: ptconfigure cleofy list
- standard
Create a default set of ptconfigure autopilots in build/config/ptconfigure/autopilots for your project.
example: ptconfigure cleofy standard
- tiny
Create a default set of ptconfigure autopilots in build/config/ptconfigure/autopilots for a project with a "tiny" style infrastructure. example: ptconfigure cleofy tiny
- medium
Create a default set of ptconfigure autopilots in build/config/ptconfigure/autopilots for a project with a "medium" style infrastructure. example: ptconfigure cleofy medium
- medium-web
Create a default set of ptconfigure autopilots in build/config/ptconfigure/autopilots for a project with a "medium" style infrastructure,
with web but not database.
example: ptconfigure cleofy medium-web
- db-cluster
Create a default set of ptconfigure autopilots in build/config/ptconfigure/autopilots for your project.
example: ptconfigure cleofy db-cluster
--yes
--guess
--database-nodes-env=*db-nodes-environment-name*
- install-generic-autopilots
Install the generic Cleofy autopilot templates for a Tiny or Medium (Current Default) set of Environments
example: ptconfigure cleofy install-generic-autopilots
example: ptconfigure cleofy install-generic-autopilots
--yes
--guess # will set --destination-dir=*this dir +*build/config/ptconfigure/cleofy/autopilots/
--template-group=tiny # tiny, medium, dbcluster, phlagrant || db-cluster, workstation
--destination-dir=*path-to-destination*
------------------------------
End Help
******************************
This topic depicts about the various functions of cleofy under this module as listed below,
This function aims at listing all the autopilot files in your specified location(build/config/ptconfigure/autopilots). The syntax for applying this function is shown below,
ptconfigure cleofy list
This function assists in creating a default set of ptconfigure autopilots (in build/config/ptconfigure/autopilots) for the project of the users. This function can be applied simply by using the command below,
ptconfigure cleofy standard
kevell@corp:/# ptconfigure cleofy standard
Cleofy This? (Y/N)
y
Environment 1 :
Default Settings for Any App not setup for environment enter them now.
Value for: Name of this Environment
test1
Value for: Default Temp Dir (should usually be /tmp/)
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-cleo-dapper.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-cm-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-cleo-dapper-new.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-cleo-dapper-update.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-invoke-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-prep-any-box.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/test1-prep-ubuntu.php
******************************
Success
In Cleofy
******************************
This function aims at creating a default set of ptconfigure autopilots (in build/config/ptconfigure/autopilots) for a project with tiny infrastructure. To implement this functions use the following command as below,
ptconfigure cleofy tiny
kevell@corp:/# ptconfigure cleofy tiny
Cleofy This? (Y/N)
y
Use existing environment settings? (Y/N)
y
Do you want to modify entries applicable to any app in environment kevells (Y/N)
n
Settings for cleo not setup for environment kevells enter them manually.
Environment 1 kevells :
Do you want to add another environment? (Y/N)
n
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-cleo-dapper.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-new.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-update.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-any-box.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-ubuntu.php
******************************
Success
In Cleofy
******************************
This function aims at creating a default set of ptconfigure autopilots (in build/config/ptconfigure/autopilots) for a project with medium infrastructure. To implement this functions use the following command as below,
ptconfigure cleofy medium
kevell@corp:/# ptconfigure cleofy medium
Cleofy This? (Y/N)
y
Use existing environment settings? (Y/N)
y
Do you want to modify entries applicable to any app in environment kevells (Y/N)
n
Settings for cleo not setup for environment kevells enter them manually.
Environment 1 kevells :
Do you want to add another environment? (Y/N)
n
Enter name of environment with your Stage web nodes
kevells
Enter name of environment with your Stage database nodes
kevells
Enter name of environment with your Prod web nodes
kevells
Enter name of environment with your Prod database nodes
kevells
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-cleo-dapper.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-new.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-update.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-any-box.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-ubuntu.php
******************************
Success
In Cleofy
******************************
This function aims at creating a default set of ptconfigure autopilots (in build/config/ptconfigure/autopilots) for a project with medium infrastructure with web, but not database. To implement this functions use the following command as below,
ptconfigure cleofy medium-web
kevell@corp:/# ptconfigure cleofy medium-web
Cleofy This? (Y/N)
y
Use existing environment settings? (Y/N)
y
Do you want to modify entries applicable to any app in environment kevells (Y/N)
n
Settings for cleo not setup for environment kevells enter them manually.
Environment 1 kevells :
Do you want to add another environment? (Y/N)
n
Enter name of environment with your Stage web nodes
kevells
Enter name of environment with your Prod web nodes
kevells
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-cleo-dapper.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-new.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-update.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-any-box.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-ubuntu.php
******************************
Success
In Cleofy
******************************
This function aims at creating a default set of ptconfigure autopilots (in build/config/ptconfigure/autopilots) for the users project. To implement this functions use the following command as below,
ptconfigure cleofy db-cluster
--yes
--guess
--database-nodes-env=*db-nodes-environment-name*
kevell@corp:/# ptconfigure cleofy db-cluster
Cleofy This? (Y/N)
y
Use existing environment settings? (Y/N)
y
Do you want to modify entries applicable to any app in environment kevells (Y/N)
n
Settings for cleo not setup for environment kevells enter them manually.
Environment 1 kevells :
Do you want to add another environment? (Y/N)
n
Enter name of environment with your Databasenodes
kevells
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-cleo-dapper.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-cm-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-bastion.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-build-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-new.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-cleo-dapper-update.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-db-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-git.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-standalone-server.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-load-balancer.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-invoke-web-node.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-any-box.php
/home/kevells/build/config/ptconfigure/cleofy/autopilots/generated/kevells-prep-ubuntu.php
******************************
Success
In Cleofy
******************************
This function assists in installing generic autopilot templates for tiny or medium set of environment by simply using the command as given below,
ptconfigure cleofy install-generic-autopilots
Or
ptconfigure cleofy install-generic-autopilots
--yes
--guess # will set --destination-dir=*this dir +*build/config/ptconfigure/cleofy/autopilots/
--template-group=tiny # tiny, medium, dbcluster, phlagrant || db-cluster, workstation
--destination-dir=*path-to-destination*
To implement the command as given above, the user have to specify the following fields as listed,
kevell@corp:/# ptconfigure cleofy install-generic-autopilots
Enter Template Group:
(0) tiny
(1) medium
0
Enter Destination Directory:
/tmp/
[Pharaoh Logging] Performing file copy from /opt/ptconfigure-enterprise/src/Modules/Cleofy/Templates/Generic/Tiny to /tmp/
******************************
Cleofy Listing:
--------------------------------------------
Success
------------------------------
Cleofy Generic Autopilot Install Finished
******************************
The alternative parameters for this module, either of which can be used in declaration is,