Metadata-Version: 2.1
Name: aws_eden_cli
Version: 0.1.5
Summary: ECS Dynamic Environment Manager (eden) CLI
Home-page: https://github.com/baikonur-oss/aws-eden-cli
Author: Tamirlan Torgayev
Author-email: torgayev@me.com
License: MIT
Project-URL: Source Code, https://github.com/baikonur-oss/aws-eden-cli
Description: # aws-eden-cli: ECS Dynamic Environment Manager [![PyPi version](https://img.shields.io/pypi/v/aws-eden-cli.svg)](https://pypi.python.org/pypi/aws-eden-cli/) ![](https://img.shields.io/badge/python-3.6+-blue.svg) ![t](https://img.shields.io/badge/status-beta-orange.svg) 
        
        
        Clone Amazon ECS environments easily. 
        Provide eden with a Amazon ECS service and eden will clone it. 
        
        eden is provided in CLI and Terraform module (Lambda with HTTP API) flavors. 
        You can use HTTP API from CI of your choice on Pull Request open/close, 
        new commit pushes to fully automate environment creation. 
        For API flavor, see eden API at [GitHub](https://github.com/baikonur-oss/terraform-aws-lambda-eden-api).
        
        Works only with Python 3.6+.
        
        ## Developing with eden
        
        ![simple-figure](figures/aws-eden-simple-en.png)
        
        ## Requirements:
        1. Config JSON file in a S3 bucket with structure described below
        2. A reference ECS Service with Target Group Attached
        3. An ALB with HTTPS Listener
            - Will be reused by all environments with Host Header Listener Rules
            - Separate from what reference service uses
            - Listener must have wildcard certificate for target dynamic zone
        4. Simple ALB usage
            - No multiple path rules etc.
            - One ALB per one ECS Service
        
        ## What it does
        ### Resources created/deleted
        eden creates
        1. ECS Task Definition 
            -  Cloned from reference service
        2. ALB (elbv2) Target Group 
            - Settings cloned from Target Group attached to reference service
        3. ECS Service
            - Created in the same cluster as reference service
        4. ALB Listener Rule
            - Host Header rule
        5. Route 53 CNAME record
            - Points at common ALB
        6. An entry is added to config JSON file
        
        eden deletes resources in reverse order.
        
        ### Config JSON file
        Config file is used to:
        1. Check what environments exist and where their endpoints are
        2. Tell client apps what is available
        
        Config file format:
        ```json
        {
            "environments": [
                {
                    "env": "dev",
                    "name": "dev-dynamic-test",
                    "api_endpoint": "api-test.dev.example.com"
                }
            ]
        }
        ```
        Example above presumes `config_update_key = api_endpoint`. You can use multiple Lambdas/invoke eden-cli multiple times with different update keys to have multiple endpoints within single environment.
        
        For example, you may want to have API, administration tool and a frontend service created as a single environment. Your environment file could look like this:
        ```json
        {
            "environments": [
                {
                    "env": "dev",
                    "name": "dev-dynamic-test",
                    "api_endpoint": "api-test.dev.example.com",
                    "admin_endpoint": "admin-test.dev.example.com",
                    "frontend_endpoint": "test.dev.example.com"
                }
            ]
        }
        ```
        
        ## Usage (CLI interface)
        ### Installation
        ```
        $ pip3 install aws-eden-cli 
        
        $ eden -h
        usage: eden [-h] {create,delete,config} ...
        
        ECS Dynamic Environment Manager. Clone Amazon ECS environments easily.
        
        positional arguments:
          {create,delete,config}
            create              Create environment or deploy to existent
            delete              Delete environment
            config              Configure eden
        
        optional arguments:
          -h, --help            show this help message and exit
        ```
        
        Hint: you can use -h on subcommands as well:
        ```
        $ eden config -h
         usage: eden config [-h] {setup,check,push,remote-rm} ...
        
        positional arguments:
          {setup,check,push,remote-rm}
            setup               Setup profiles for other commands
            check               Check configuration file integrity
            push                Push local profile to DynamoDB for use by eden API
            remote-rm           Remove remote profile from DynamoDB
        
        optional arguments:
          -h, --help            show this help message and exit
        
        $ eden config push -h
        usage: eden config push [-h] [-p PROFILE] [-c CONFIG_PATH] [-v]
                                [--remote-table-name REMOTE_TABLE_NAME]
        
        optional arguments:
          -h, --help            show this help message and exit
          -p PROFILE, --profile PROFILE
                                profile name in eden configuration file
          -c CONFIG_PATH, --config-path CONFIG_PATH
                                eden configuration file path
          -v, --verbose
          --remote-table-name REMOTE_TABLE_NAME
                                profile name in eden configuration file
        ```
        
        ### Configure
        ```
        # let's create a profile to work with, 
        # so we won't have to specify all the parameters every time
        
        $ eden config setup --config-bucket-key endpoints.json
        $ eden config setup --config-bucket-name servicename-config
        $ eden config setup --config-update-key api_endpoint
        $ eden config setup --config-name-prefix servicename-dev
        $ eden config setup --domain-name-prefix api
        $ eden config setup --dynamic-zone-id Zxxxxxxxxxxxx
        $ eden config setup --dynamic-zone-name dev.example.com.
        $ eden config setup --master-alb-arn arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxxxx:loadbalancer/app/dev-alb-api-dynamic/xxxxxxxxxx
        $ eden config setup --name-prefix dev-dynamic
        $ eden config setup --reference-service-arn arn:aws:ecs:ap-northeast-1:xxxxxxxxxxxx:service/dev/dev01-api
        $ eden config setup --target-cluster dev
        $ eden config setup --target-container-name api
        
        # you can also edit ~/.eden/config directly
        # (you can see that commands above created a "default" profile)
        
        $ cat ~/.eden/config
        [api]
        name_prefix = dev-dynamic
        reference_service_arn = arn:aws:ecs:ap-northeast-1:xxxxxxxxxxxx:service/dev/dev01-api
        target_cluster = dev
        domain_name_prefix = api
        master_alb_arn = arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxxxx:loadbalancer/app/dev-alb-api-dynamic/xxxxxxxxxx
        dynamic_zone_name = dev.example.com.
        dynamic_zone_id = Zxxxxxxxxxxxx
        config_bucket_name = servicename-config
        config_bucket_key = endpoints.json
        config_update_key = api_endpoint
        config_env_type = dev
        config_name_prefix = servicename-dev
        target_container_name = api
        
        # don't forget to check configuration file integrity
        
        $ eden config check
        No errors found
        ```
        
        ### Profiles
        ```
        # you can specify multiple profiles in configuration
        # and select a profile with -p profile_name
        
        $ eden config check -p api
        No errors found
        
        # we can push profiles to DynamoDB for use by eden API
        # (if eden table does not exist, aws-eden-cli will create it)
        
        $ eden config push -p api
        Waiting for table creation...
        Successfully pushed profile api to DynamoDB
        
        # use the same command to overwrite existing profiles
        # (push to existing profile will result in overwrite)
        
        $ eden config push -p api
        Successfully pushed profile api to DynamoDB table eden
        
        # use remote-rm to remove remote profiles
        
        $ eden config remote-rm -p api
        Successfully removed profile api from DynamoDB table eden
        ```
        
        ### Execute commands
        ```
        $ eden create -p api --name foo --image-uri xxxxxxxxxx.dkr.ecr.ap-northeast-1.amazonaws.com/api:latest
        Checking if image xxxxxxxxxx.dkr.ecr.ap-northeast-1.amazonaws.com/api:latest exists
        Image exists
        Retrieved reference service arn:aws:ecs:ap-northeast-1:xxxxxxxxxx:service/dev/api
        Retrieved reference task definition from arn:aws:ecs:ap-northeast-1:xxxxxxxxxx:task-definition/api:20
        Registered new task definition: arn:aws:ecs:ap-northeast-1:xxxxxxxxxx:task-definition/dev-dynamic-api-foo:1
        Registered new task definition: arn:aws:ecs:ap-northeast-1:xxxxxxxxxx:task-definition/dev-dynamic-api-foo:1
        Retrieved reference target group: arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxx:targetgroup/api/xxxxxxxxxxxx
        Existing target group dev-dynamic-api-foo not found, will create new
        Created target group arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxx:targetgroup/dev-dynamic-api-foo/xxxxxxxxxxxx
        ELBv2 listener rule for target group arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxx:targetgroup/dev-dynamic-api-foo/xxxxxxxxxxxx and host api-foo.dev.example.com does not exist, will create new listener rule
        ECS Service dev-dynamic-api-foo does not exist, will create new service
        Checking if record api-foo.dev.example.com. exists in zone Zxxxxxxxxx
        Successfully created CNAME: api-foo.dev.example.com -> dev-alb-api-dynamic-297517510.ap-northeast-1.elb.amazonaws.com
        Updating config file s3://example-com-config/endpoints.json, environment example-api-foo: nodeDomain -> api-foo.dev.example.com
        Existing environment not found, adding new
        Successfully updated config file
        Successfully finished creating environment dev-dynamic-api-foo
        
        $ eden ls
        Profile api:
        dev-dynamic-api-foo api-foo.dev.example.com (last updated: 2019-11-20T19:44:10.179760)
        
        $ eden delete -p api --name foo
        Updating config file s3://example-com-config/endpoints.json, delete environment example-api-foo: nodeDomain -> api-foo.dev.example.com
        Existing environment found, and the only optional key is nodeDomain,deleting environment
        Successfully updated config file
        Checking if record api-foo.dev.example.com. exists in zone Zxxxxxxxxx
        Found existing record api-foo.dev.example.com. in zone Zxxxxxxxxx
        Successfully removed CNAME record api-foo.dev.example.com
        ECS Service dev-dynamic-api-foo exists, will delete
        Successfully deleted service dev-dynamic-api-foo from cluster dev
        ELBv2 listener rule for target group arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxx:targetgroup/dev-dynamic-api-foo/xxxxxxxxxxxx and host api-foo.dev.example.com found, will delete
        Deleted target group arn:aws:elasticloadbalancing:ap-northeast-1:xxxxxxxxxx:targetgroup/dev-dynamic-api-foo/xxxxxxxxxxxx
        Deleted all task definitions for family: dev-dynamic-api-foo, 1 tasks deleted total
        Successfully finished deleting environment dev-dynamic-api-foo
        
        $ eden ls
        No environments available
        
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
