Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 3 KB

README.md

File metadata and controls

53 lines (39 loc) · 3 KB
Raw

CKEditor Collaboration Server On-Premises AWS Terraform module

Use this Terraform module to provision infrastructure hosted in AWS for Collaboration Server On-Premises. A single module will create all the resources needed to run an On-Premises application using ECS Fargate.

Note: This module is made for Terraform. If you haven't worked with it before, we highly recommend getting familiar with it first: https://www.terraform.io/intro

List of created resources

  • Network resources: VPC, subnets, route tables, internet and NAT gateways.
  • Load balancer and ECS cluster with ECS task running CKEditor Collaboration Server On-Premises application.
  • Redis and MySQL databases in private subnets.
  • S3 bucket for Easy Image and collaboration storage.

Note: This module will create only HTTP listener for the load balancer. You need to adjust the script to use your custom domain and HTTPS listeners.

Usage

Ensure you have terraform in version 1.7.4 or higher and your AWS credentials are configured properly.

  1. Clone the repository
git clone [email protected]:cksource/ckeditor-cs-on-premises-infrastructure.git
  1. Initialize terraform
cd aws/ecs
terraform init
  1. (Optionally) Create a terraform.tfvars file in aws/ecs folder with the following variables:
image_version = ""
license_key = ""
docker_token = ""
environments_management_secret_key = ""

Note:

  • The image_version property should be set to the version of CKEditor Collaboration Server On-Premises image that you want to run. By default, the module uses the CKEditor Collaboration Server On-Premises with the "latest" tag. If you are using this module for a production environment, it's strongly recommended to change the container image tag to a numeric representation of the version you want to use. Refer to https://ckeditor.com/docs/cs/latest/onpremises/cs-onpremises/changelog.html for the list of currently available versions.
  • The license_key property can be found in CKEditor Ecosystem Dashboard in your CKEditor Collaboration Server On-Premises subscription page.
  • The docker_token property can be found in the CKEditor Ecosystem Dashboard in your CKEditor Collaboration Server On-Premises subscription page in the Download token section. If you do not see any tokens, you can create them with the Create new token button.
  • The environments_management_secret_key property is your password, which is used to access the Collaboration Server On-Premises management panel

  1. You can change the AWS region in which the resources will be created in aws/ecs/main.tf. Refer to the aws/ecs/cs-on-premises/variables.tf file to see which properties of the application can be optionally configured in the module.

  2. Create all required resources:

terraform apply

Note: It may take several minutes, wait until the command finishes.

Application URL will be printed as terraform output after all resources are created.