diff --git a/Deploy/AWS ECS Deployment.md b/Deploy/AWS ECS Deployment.md index 1f9d267..828746e 100644 --- a/Deploy/AWS ECS Deployment.md +++ b/Deploy/AWS ECS Deployment.md @@ -9,9 +9,9 @@ nav_order: 2 The following sections will guide you through the steps to setup a GitAction workflow to deploy the Reflectance Datacube processor on AWS ECS. -Before starting the deployment configuration, please make sure to check the [prerequisite section](Prerequisite.html). +Before starting the deployment configuration, please make sure to check the [prerequisite section](../Prerequisite.html). -Infrastructure setup is detailed on the [provisioning section](Provisioning.html). +Infrastructure setup is detailed on the [provisioning section](../Provisioning.html). ## Clone repository @@ -21,7 +21,7 @@ Detailed process is available [here](https://docs.github.com/en/repositories/cre ## Ressources creation -Please refer to [here](./Provisioning.html) to create the ressources needed and use the option 2: ECS. +Please refer to [here](../Provisioning.html#option-2-ecs) to create the ressources needed and use the option 2: ECS. ## Github repo configuration Before configuring the deployment workflow, set the deployment variables in the GitHub repository secrets for actions. The workflow requires these variables in order to successfully push the image. @@ -38,10 +38,10 @@ Before configuring the deployment workflow, set the deployment variables in the | ECS_SERVICE | ECS Service for container deployment | | ECS_TASK_DEFINITION | ECS Task definition for container deployment | | EDS_API_URL | Base URL to access EarthData Store | -| EDS_AUTH_URL | Base authentication URL to access EarthData Store (information regarding this information [here](./Provisioning.html#earthdaily-authentication)) | +| EDS_AUTH_URL | Base authentication URL to access EarthData Store (information regarding this information [here](./Provisioning.html) | | AWS_ACCESS_KEY_ID | S3 Access key to push datacube assets | | AWS_SECRET_ACCESS_KEY | S3 Secret Access key to push datacube assets | -| DEPLOY_LAMBDA | Boolean value to enable Lambda deployment (deplyoed to ECS if false) | +| DEPLOY_LAMBDA | Boolean value to enable Lambda deployment (deployed to ECS if false) | ## Deployment workflow Whithin the Github repository, in the '.github/workflows, you will find a file AWS_deploy.yml diff --git a/Deploy/AWS ECS FTR.md b/Deploy/AWS ECS FTR.md index 0968ef8..f75d417 100644 --- a/Deploy/AWS ECS FTR.md +++ b/Deploy/AWS ECS FTR.md @@ -43,7 +43,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
Introductory material contains an overview of a typical customer deployment, including lists of all resources that are set up when the deployment is complete.
This is covered in the Reflectance Datacube processor section on the architecture diagram.
+This is covered in the Reflectance Datacube processor section on the architecture diagram.
All technical prerequisites and requirements to complete the deployment process are listed (e.g. required OS, database type and storage requirements).
This is covered in the Prerequisites section.
+This is covered in the Prerequisites section.
The deployment guide lists all prerequisite skills or specialized knowledge (for example, familiarity with AWS, specific AWS services, or a scripting or programming language).
This is covered in the Prerequisites section.
+This is covered in the Prerequisites section.
Architecture diagrams must include all AWS services and resources deployed by the solution and illustrate how the services and resources connect with each other in a typical customer environment.
This is covered in the Reflectance Datacube processor section
+This is covered in the Reflectance Datacube processor section
Architecture diagrams use official AWS Architecture Icons.
Reflectance Datacube processor section includes a diagram with official AWS Icon coming from here
+Reflectance Datacube processor section includes a diagram with official AWS Icon coming from here
Network diagrams demonstrate virtual private clouds (VPCs) and subnets.
Reflectance Datacube processor section includes a diagram with VPC
+Reflectance Datacube processor section includes a diagram with VPC
Architecture diagrams show integration points, including third-party assets/APIs and on-premises/hybrid assets.
Reflectance Datacube processor section includes a diagram with link to EarthPlatform (third party data infrastructure running on AWS)
+Reflectance Datacube processor section includes a diagram with link to EarthPlatform (third party data infrastructure running on AWS)
The application does not require the use of AWS account root privileges for deployment or operation.
As detailed in the prerequisites section, access to AWS ressoures is based on OIDC with specific role and specific trust relationship.
+As detailed in the prerequisites section, access to AWS ressoures is based on OIDC with specific role and specific trust relationship.
The deployment guide provides prescriptive guidance on following the policy of least privilege for all access granted as part of the deployment.
As defined in the provisioning section, deployment and execution is based on a specific role enforcing the least privilege principle.
+As defined in the provisioning section, deployment and execution is based on a specific role enforcing the least privilege principle.
The deployment guide describes the purpose of each AWS Identity and Access Management (IAM) role and IAM policy the user is instructed to create.
The deployment guide includes a specific chapter on IAM configuration and OIDC setup.
+The deployment guide includes a specific chapter on IAM configuration and OIDC setup.
The deployment guide includes a list of billable services and guidance on whether each service is mandatory or optional.
The deployment guide includes the cost model and licensing costs.
The deployment guide provides step-by-step instructions for deploying the workload on AWS according to the typical deployment architecture.
The deployment guide includes step by step procedure to provision AWS resources and a script to automatically deploy assets to AWS
+The deployment guide includes step by step procedure to provision AWS resources and a script to automatically deploy assets to AWS
The deployment guide contains prescriptive guidance for testing and troubleshooting.
The deployment guide contains a user guide section.
+The deployment guide contains a user guide section.
The deployment guide provides step-by-step instructions for deploying the workload on AWS according to the typical deployment architecture.
The deployment guide includes step by step procedure to provision AWS resources and a script to automatically deploy assets to AWS
+The deployment guide includes step by step procedure to provision AWS resources and a script to automatically deploy assets to AWS
The deployment guide contains prescriptive guidance for testing and troubleshooting.
The deployment guide contains a user guide section.
+The deployment guide contains a user guide section.
The deployment guide provides step-by-step instructions for how to assess and monitor the health and proper function of the application.
This is detailed in the lifecycle management section.
+This is detailed in the lifecycle management section.
Identify the data stores and the configurations to be backed up. If any of the data stores are proprietary, provide step-by-step instructions for backup and recovery.
This is detailed in the lifecycle management section.
+This is detailed in the lifecycle management section.
The deployment guide provides prescriptive guidance on managing AWS service limits.
This is detailed in the lifecycle management section.
+This is detailed in the lifecycle management section.
The deployment guide provides details on how to receive support.
User support is described here
+User support is described here