Skip to content
Snippets Groups Projects
Commit 8ddbe4e0 authored by Yas Naoi's avatar Yas Naoi
Browse files

Issue #3233607 by yas, baldwinlouie: Update README.md for CFn templates

parent 87e6ec6c
No related branches found
No related tags found
No related merge requests found
...@@ -3,36 +3,66 @@ USAGE INSTRUCTIONS ...@@ -3,36 +3,66 @@ USAGE INSTRUCTIONS
The following Cloud Formation templates are provided. The following Cloud Formation templates are provided.
- cloud_orchestrator_full.yaml - Builds a fully distributed Cloud Orchestrator - `cloud_orchestrator_full.yaml`
distribution. It uses RDS/Mysql for a database, ElastiCache for memcache and - Builds a fully distributed Cloud Orchestrator
EC2 with LAMP stack to run Cloud Orchestrator. distribution.
- cloud_orchestrator_full_manual_vpc.yaml - Builds a fully distributed Cloud - Database: **RDS (MySQL)**
Orchestrator distribution. It uses RDS/Mysql for a database, ElastiCache for - Memcache: **ElastiCache (Memcached)**
memcache and EC2 with LAMP stack to run Cloud Orchestrator. This template lets - Runtime: **EC2** with LAMP stack
a user choose a VPC and Subnet for the EC2 instance. - VPC: **Automatic**
- cloud_orchestrator_single.yaml - Builds a Cloud Orchestrator distribution - `cloud_orchestrator_full_manual_vpc.yaml`
fully contained in a single EC2 instance. This template lets a user choose a - Builds a fully distributed Cloud Orchestrator distribution. This template
VPC and Subnet for the EC2 instance. lets a user choose a VPC and Subnet for the EC2 instance.
- cloud_orchestrator_single_manual_vpc.yaml - Builds a Cloud Orchestrator - Runtime: **EC2** with LAMP stack
distribution fully contained in a single EC2 instance. - Database: **RDS** (MySQL)
- cloud_orchestrator_docker.yaml - Build a Cloud Orchestrator distribution - Memcache: **ElastiCache (Memcached)**
running individual Docker containers in a single EC2 instance. - VPC: **User-specified VPC and Subnet**
- cloud_orchestrator_docker_manual_vpc.yaml - Builds a Cloud Orchestrator - `cloud_orchestrator_single.yaml`
distribution running individual Docker containers in a single EC2 instance. - Builds a Cloud Orchestrator distribution fully contained in a single EC2
This template lets a user choose a VPC and Subnet for the EC2 instance. instance.
cloud_orchestrator_docker_rds_manual_vpc.yaml - Builds a Cloud Orchestrator - Runtime: **EC2** with LAMP stack
distribution running individual Docker containers in a single EC2 instance. The - Database: **MariaDB**
database is running on RDS. This template lets a user choose a VPC and Subnet - Memcache: **Memached**
for the EC2 instance. - VPC: **Automatic**
- `cloud_orchestrator_single_manual_vpc.yaml`
- Fully contained in a single EC2 instance. This template lets a user choose a
VPC and Subnet for the EC2 instance. Builds a Cloud Orchestrator distribution.
- Runtime: **EC2** with LAMP stack
- Database: **MariaDB**
- Memcache: **Memached**
- VPC: **User-specified VPC and Subnet**
- `cloud_orchestrator_docker.yaml`
- Build a Cloud Orchestrator distribution running individual Docker containers
in a single EC2 instance.
- Runtime: **Docker on EC2** with LAMP stack
- Database: **MariaDB**
- Memcache: **Memached**
- VPC: Automatic
- `cloud_orchestrator_docker_manual_vpc.yaml`
- Builds a Cloud Orchestrator distribution running individual Docker
containers in a single EC2 instance. This template lets a user choose a VPC and
Subnet for the EC2 instance.
- Runtime: **Docker** on EC2 with LAMP stack
- Database: **MariaDB**
- Memcache: **Memached**
- VPC: **User-specified VPC and Subnet**
- `cloud_orchestrator_docker_rds_manual_vpc.yaml`
- Builds a Cloud Orchestrator distribution running individual Docker
containers in a single EC2 instance. The database is running on RDS. This
template lets a user choose a VPC and Subnet for the EC2 instance.
- Runtime: **Docker on EC2** with LAMP stack
- Database: **RDS (MySQL)**
- Memcache: **Memached**
- VPC: **User-specified VPC and Subnet**
The packaged version of these templates are hosted in S3. The packaged version of these templates are hosted in S3.
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_full.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_full.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_full_manual_vpc.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_full_manual_vpc.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_single.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_single.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_single_manual_vpc.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_single_manual_vpc.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker.yml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker_manual_vpc.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker_manual_vpc.yaml
https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker_rds_manual_vpc.yaml - https://cloud-orchestrator.s3.amazonaws.com/cfn/cloud_orchestrator_docker_rds_manual_vpc.yaml
To package the templates for your own usage, follow these steps: To package the templates for your own usage, follow these steps:
......
...@@ -275,11 +275,12 @@ Resources: ...@@ -275,11 +275,12 @@ Resources:
Ref: CloudOrchestratorVersion Ref: CloudOrchestratorVersion
Outputs: Outputs:
Instructions: Instructions:
Value: The CFn template has completed. Please allow 10-15 minutes for the install Value: The CFn template has completed. However, please allow an extra 10-15
script to complete the Cloud Orchestrator installation. To follow the installation minutes for the install script to complete the Cloud Orchestrator
progress, access the instance using SSH and tail the /var/log/cloud-init-output.log installation. To follow the installation progress, access the instance
file. Once completed, use the DrupalUserName and DrupalPassword to log into using SSH and tail the /var/log/cloud-init-output.log file. Once
your Cloud Orchestrator instance. completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: Value:
Fn::GetAtt: Fn::GetAtt:
......
...@@ -263,11 +263,12 @@ Resources: ...@@ -263,11 +263,12 @@ Resources:
Ref: CloudOrchestratorVersion Ref: CloudOrchestratorVersion
Outputs: Outputs:
Instructions: Instructions:
Value: The CFn template has completed. Please allow 10-15 minutes for the install Value: The CFn template has completed. However, please allow an extra 10-15
script to complete the Cloud Orchestrator installation. To follow the installation minutes for the install script to complete the Cloud Orchestrator
progress, access the instance using SSH and tail the /var/log/cloud-init-output.log installation. To follow the installation progress, access the instance
file. Once completed, use the DrupalUserName and DrupalPassword to log into using SSH and tail the /var/log/cloud-init-output.log file. Once
your Cloud Orchestrator instance. completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: Value:
Fn::GetAtt: Fn::GetAtt:
......
...@@ -361,12 +361,12 @@ Resources: ...@@ -361,12 +361,12 @@ Resources:
CloudOrchestratorVersion: !Ref CloudOrchestratorVersion CloudOrchestratorVersion: !Ref CloudOrchestratorVersion
Outputs: Outputs:
Instructions: Instructions:
Value: The CFn template has completed. Please allow 10-15 minutes for the Value: The CFn template has completed. However, please allow an extra 10-15
install script to complete the Cloud Orchestrator installation. To minutes for the install script to complete the Cloud Orchestrator
follow the installation progress, access the instance using SSH and tail installation. To follow the installation progress, access the instance
the /var/log/cloud-init-output.log file. Once completed, use the using SSH and tail the /var/log/cloud-init-output.log file. Once
DrupalUserName and DrupalPassword to log into your Cloud Orchestrator completed, use the DrupalUserName and DrupalPassword to log into your
instance. Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: !GetAtt Ec2Instance.Outputs.SSHAccess Value: !GetAtt Ec2Instance.Outputs.SSHAccess
DrupalUrl: DrupalUrl:
......
...@@ -395,10 +395,12 @@ Resources: ...@@ -395,10 +395,12 @@ Resources:
Outputs: Outputs:
Instructions: Instructions:
Value: >- Value: >-
The CFn template has completed. Please allow 10-15 minutes for the install script to The CFn template has completed. However, please allow an extra 10-15
complete the Cloud Orchestrator installation. To follow the installation progress, minutes for the install script to complete the Cloud Orchestrator
access the instance using SSH and tail the /var/log/cloud-init-output.log file. Once completed, installation. To follow the installation progress, access the instance
use the DrupalUserName and DrupalPassword to log into your Cloud Orchestrator instance. using SSH and tail the /var/log/cloud-init-output.log file. Once
completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: !GetAtt Ec2Instance.Outputs.SSHAccess Value: !GetAtt Ec2Instance.Outputs.SSHAccess
DrupalUrl: DrupalUrl:
......
...@@ -417,10 +417,12 @@ Resources: ...@@ -417,10 +417,12 @@ Resources:
Outputs: Outputs:
Instructions: Instructions:
Value: >- Value: >-
The CFn template has completed. Please allow 10-15 minutes for the install script to The CFn template has completed. However, please allow an extra 10-15
complete the Cloud Orchestrator installation. To follow the installation progress, minutes for the install script to complete the Cloud Orchestrator
access the instance using SSH and tail the /var/log/cloud-init-output.log file. Once completed, installation. To follow the installation progress, access the instance
use the DrupalUserName and DrupalPassword to log into your Cloud Orchestrator instance. using SSH and tail the /var/log/cloud-init-output.log file. Once
completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: !GetAtt Ec2Instance.Outputs.SSHAccess Value: !GetAtt Ec2Instance.Outputs.SSHAccess
DrupalUrl: DrupalUrl:
......
...@@ -275,11 +275,12 @@ Resources: ...@@ -275,11 +275,12 @@ Resources:
Ref: CloudOrchestratorVersion Ref: CloudOrchestratorVersion
Outputs: Outputs:
Instructions: Instructions:
Value: The CFn template has completed. Please allow 10-15 minutes for the install Value: The CFn template has completed. However, please allow an extra 10-15
script to complete the Cloud Orchestrator installation. To follow the installation minutes for the install script to complete the Cloud Orchestrator
progress, access the instance using SSH and tail the /var/log/cloud-init-output.log installation. To follow the installation progress, access the instance
file. Once completed, use the DrupalUserName and DrupalPassword to log into using SSH and tail the /var/log/cloud-init-output.log file. Once
your Cloud Orchestrator instance. completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: Value:
Fn::GetAtt: Fn::GetAtt:
......
...@@ -263,11 +263,12 @@ Resources: ...@@ -263,11 +263,12 @@ Resources:
Ref: CloudOrchestratorVersion Ref: CloudOrchestratorVersion
Outputs: Outputs:
Instructions: Instructions:
Value: The CFn template has completed. Please allow 10-15 minutes for the install Value: The CFn template has completed. However, please allow an extra 10-15
script to complete the Cloud Orchestrator installation. To follow the installation minutes for the install script to complete the Cloud Orchestrator
progress, access the instance using SSH and tail the /var/log/cloud-init-output.log installation. To follow the installation progress, access the instance
file. Once completed, use the DrupalUserName and DrupalPassword to log into using SSH and tail the /var/log/cloud-init-output.log file. Once
your Cloud Orchestrator instance. completed, use the DrupalUserName and DrupalPassword to log into your
Cloud Orchestrator instance.
SSHAccess: SSHAccess:
Value: Value:
Fn::GetAtt: Fn::GetAtt:
......
...@@ -134,7 +134,7 @@ Resources: ...@@ -134,7 +134,7 @@ Resources:
DBName: !Ref DatabaseName DBName: !Ref DatabaseName
DBSubnetGroupName: !Ref DbSubnetGroup DBSubnetGroupName: !Ref DbSubnetGroup
Engine: MySQL Engine: MySQL
EngineVersion: 5.7.22 EngineVersion: 5.7.34
MasterUsername: !Ref MySQLUserName MasterUsername: !Ref MySQLUserName
MasterUserPassword: !Ref MySQLPassword MasterUserPassword: !Ref MySQLPassword
Port: '3306' Port: '3306'
......
...@@ -151,8 +151,8 @@ Parameters: ...@@ -151,8 +151,8 @@ Parameters:
Type: String Type: String
MySQLUserName: MySQLUserName:
Description: >- Description: >-
Username for the RDS. Must be between 5 and 16 characters and only contain Username for the MariaDB. Must be between 5 and 16 characters and only
alphanumeric characters and underscores. contain alphanumeric characters and underscores.
Default: administrator Default: administrator
Type: String Type: String
NoEcho: 'false' NoEcho: 'false'
...@@ -164,9 +164,9 @@ Parameters: ...@@ -164,9 +164,9 @@ Parameters:
and must be between 5 and 16 characters long. and must be between 5 and 16 characters long.
MySQLPassword: MySQLPassword:
Description: >- Description: >-
Password for the RDS Username. Must be between 6 and 32 characters and Password for the MariaDB Username. Must be between 6 and 32 characters
only contain alphanumeric characters and these special and only contain alphanumeric characters, or these special characters
characters '_'`~!#$%^&*()_+,-. '_'`~!#$%^&*()_+,-.
Type: String Type: String
MinLength: '6' MinLength: '6'
MaxLength: '32' MaxLength: '32'
......
...@@ -166,8 +166,8 @@ Parameters: ...@@ -166,8 +166,8 @@ Parameters:
MySQLPassword: MySQLPassword:
Description: >- Description: >-
Password for the RDS Username. Must be between 6 and 32 characters and Password for the RDS Username. Must be between 6 and 32 characters and
only contain alphanumeric characters and these special only contain alphanumeric characters, or these special characters
characters '_'`~!#$%^&*()_+,-. '_'`~!#$%^&*()_+,-.
Type: String Type: String
MinLength: '6' MinLength: '6'
MaxLength: '32' MaxLength: '32'
......
...@@ -166,8 +166,8 @@ Parameters: ...@@ -166,8 +166,8 @@ Parameters:
MySQLPassword: MySQLPassword:
Description: >- Description: >-
Password for the RDS Username. Must be between 6 and 32 characters and Password for the RDS Username. Must be between 6 and 32 characters and
only contain alphanumeric characters and these special only contain alphanumeric characters, or these special characters
characters '_'`~!#$%^&*()_+,-. '_'`~!#$%^&*()_+,-.
Type: String Type: String
MinLength: '6' MinLength: '6'
MaxLength: '32' MaxLength: '32'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment