Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 3.96 KB

use_of_stax_orchestrator.md

File metadata and controls

72 lines (56 loc) · 3.96 KB

Stax Deployment Bucket

Inorder to use Stax to deploy workloads, we need to use s3 bucket accessible by Stax to store our artifacts, our cloudformation templates and package dependencies.

Stax provides a workload stax-deployment-bucket manifest deployed in every installation (AU1, US1, EU1) that we can deploy to then start using the s3 bucket to store artifacts. Follow Stax's guide to get started.

For workload parameter StaxRootAccountId enter the Stax root AWS Account ID from your current installation which can be found here. This is required for Stax to GET catalogue manifests deployed in the s3 bucket.

After you deploy the stax-deployment-bucket workload,

  • Store the name of the bucket in a Ssm parameter with path /orchestrator/stax/artifact/bucket/name which will be consumed by Stax Orchestrator. An example script can be found in examples/create_ssm_parameters.py which can be used to populate SSM parameters.
  • Add a policy to allow AWS's Serverless Service access the bucket to get artifacts.

Deploying a workload

  • Deploy a Stax workload catalogue.

    • Remember the Catalogue ID of the catalogue deployed as we will need this to deploy the workload.

  • Run Workload Step Function step function with the following payload,

    {
    "aws_account_id": "asd12e3-7c0e-4807-96ee-asd12ec21r2",
    "aws_region": "ap-southeast-2",
    "operation": "deploy",
    "catalogue_id": "b3437e3b-55e3-4060-9dec-042f18dcf789",
    "catalogue_version_id": "69e4a16c-7c7c-48cf-bb8d-312c43fc0563",
    "workload_name": "orchestrator-stax-demo-vpc",
    "workload_parameters": {
        "Param1": "Value1"
    },
    "workload_tags": {
        "Tag1": "Value1"
    }
}
    • aws_account_id - Stax AWS Account ID (UUID) to deploy workload to.
    • aws_region - The AWS Region to deploy the workload to.
    • catalogue_id - The ID of the catalogue containing workload manifest.
    • catalogue_version_id (OPTIONAL): Deploy a specific version of the catalogue workload.
    • workload_name - Name of the workload to deploy (must be unique).
    • workload_parameters - Parameters that get passed into cloudformation templates upon workload deployment.
    • workload_tags - Tags to attach to the workload.

Updating a workload

  • Update a Stax workload catalogue.

    • Remember the Catalogue ID and version of the updated catalogue as we will need this to deploy the workload.

  • Run Workload Step Function step function with the following payload,

    {
    "operation": "update",
    "workload_id": "b3437e3b-55e3-4060-9dec-042f18dcf789",
    "catalogue_version_id": "69e4a16c-7c7c-48cf-bb8d-312c43fc0563"
}
    • workload_id - The ID of the workload to update
    • catalogue_version_id: The version of the catalogue workload to deploy

Deleting a workload

  • Run Workload Step Function step function with the following payload, 
    {
    "operation": "delete",
    "workload_id": "b3437e3b-55e3-4060-9dec-042f18dcf789"
}
    • workload_id - The ID of the workload to update