Skip to content

Commit

Permalink
update link
Browse files Browse the repository at this point in the history
  • Loading branch information
@vincentlel
vincentlel committed May 17, 2024
1 parent 7d8131b commit dd8e233
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 27 deletions.
10 changes: 5 additions & 5 deletions Deploy/AWS ECS Deployment.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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
Expand Down
40 changes: 20 additions & 20 deletions Deploy/AWS ECS FTR.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>Introductory material contains an overview of a typical customer deployment, including lists of all resources that are set up when the deployment is complete.</p>
</td>
<td width="546">
<p>This is covered in the <a href="./Reflectance_processor.html">Reflectance Datacube processor</a> section on the architecture diagram.</p>
<p>This is covered in the <a href="../Reflectance_processor.html">Reflectance Datacube processor</a> section on the architecture diagram.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -105,7 +105,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>All technical prerequisites and requirements to complete the deployment process are listed (e.g. required OS, database type and storage requirements).</p>
</td>
<td width="546">
<p>This is covered in the <a href="./Prerequisite.html">Prerequisites</a> section.</p>
<p>This is covered in the <a href="../Prerequisite.html">Prerequisites</a> section.</p>
</td>
</tr>
<tr>
Expand All @@ -116,7 +116,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide lists all prerequisite skills or specialized knowledge (for example, familiarity with AWS, specific AWS services, or a scripting or programming language).</p>
</td>
<td width="546">
<p>This is covered in the <a href="./Prerequisite.html">Prerequisites</a> section.</p>
<p>This is covered in the <a href="../Prerequisite.html">Prerequisites</a> section.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -156,7 +156,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>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.</p>
</td>
<td width="546">
<p>This is covered in the <a href="./Reflectance_processor.html#architecture">Reflectance Datacube processor section</a></p>
<p>This is covered in the <a href="../Reflectance_processor.html#architecture">Reflectance Datacube processor section</a></p>
</td>
</tr>
<tr>
Expand All @@ -167,7 +167,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>Architecture diagrams use official AWS Architecture Icons.</p>
</td>
<td width="546">
<p><a href="./Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with official AWS Icon coming from <a href="https://aws.amazon.com/fr/architecture/icons/">here</a></p>
<p><a href="../Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with official AWS Icon coming from <a href="https://aws.amazon.com/fr/architecture/icons/">here</a></p>
</td>
</tr>
<tr>
Expand All @@ -178,7 +178,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>Network diagrams demonstrate virtual private clouds (VPCs) and subnets.</p>
</td>
<td width="546">
<p><a href="./Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with VPC</p>
<p><a href="../Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with VPC</p>
</td>
</tr>
<tr>
Expand All @@ -189,7 +189,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>Architecture diagrams show integration points, including third-party assets/APIs and on-premises/hybrid assets.</p>
</td>
<td width="546">
<p><a href="./Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with link to EarthPlatform (third party data infrastructure running on AWS)</p>
<p><a href="../Reflectance_processor.html#architecture">Reflectance Datacube processor section</a> includes a diagram with link to EarthPlatform (third party data infrastructure running on AWS)</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -219,7 +219,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The application does not require the use of AWS account root privileges for deployment or operation.</p>
</td>
<td width="546">
<p>As detailed in the <a href="./Prerequisite.html#aws">prerequisites section</a>, access to AWS ressoures is based on OIDC with specific role and specific trust relationship.</p>
<p>As detailed in the <a href="../Prerequisite.html#aws">prerequisites section</a>, access to AWS ressoures is based on OIDC with specific role and specific trust relationship.</p>
</td>
</tr>
<tr>
Expand All @@ -230,7 +230,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides prescriptive guidance on following the policy of least privilege for all access granted as part of the deployment.</p>
</td>
<td width="546">
<p>As defined in the <a href="./Provisioning.html#configure-openid-connect">provisioning section</a>, deployment and execution is based on a specific role enforcing the least privilege principle.</p>
<p>As defined in the <a href="../Provisioning.html#configure-openid-connect">provisioning section</a>, deployment and execution is based on a specific role enforcing the least privilege principle.</p>
</td>
</tr>
<tr>
Expand All @@ -252,7 +252,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide describes the purpose of each AWS Identity and Access Management (IAM) role and IAM policy the user is instructed to create.</p>
</td>
<td width="546">
<p>The deployment guide includes a specific chapter on <a href="./Provisioning.html#configure-openid-connect">IAM configuration and OIDC setup.</a></p>
<p>The deployment guide includes a specific chapter on <a href="../Provisioning.html#configure-openid-connect">IAM configuration and OIDC setup.</a></p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -336,7 +336,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide includes a list of billable services and guidance on whether each service is mandatory or optional.</p>
</td>
<td width="546">
<p><a href="./Lifecycle_management.html#costs">This is detailed in the lifecycle management sections.</a></p>
<p><a href="../Lifecycle_management.html#costs">This is detailed in the lifecycle management sections.</a></p>
</td>
</tr>
<tr>
Expand All @@ -347,7 +347,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide includes the cost model and licensing costs.</p>
</td>
<td width="546">
<p><a href="./Lifecycle_management.html#costs">This is detailed in the lifecycle management sections.</a></p>
<p><a href="../Lifecycle_management.html#costs">This is detailed in the lifecycle management sections.</a></p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -377,7 +377,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides step-by-step instructions for deploying the workload on AWS according to the typical deployment architecture.</p>
</td>
<td width="280">
<p>The deployment guide includes step by step procedure to <a href="./Provisioning.html">provision AWS resources</a> and a <a href="AWS%20ECS%20Deployment.html">script to automatically deploy assets to AWS</a></p>
<p>The deployment guide includes step by step procedure to <a href="../Provisioning.html">provision AWS resources</a> and a <a href="AWS%20ECS%20Deployment.html">script to automatically deploy assets to AWS</a></p>
</td>
</tr>
<tr>
Expand All @@ -388,7 +388,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide contains prescriptive guidance for testing and troubleshooting.</p>
</td>
<td width="280">
<p>The deployment guide contains a <a href="./User%20guide.html">user guide section.</a></p>
<p>The deployment guide contains a <a href="../User%20guide.html">user guide section.</a></p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -417,7 +417,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides step-by-step instructions for deploying the workload on AWS according to the typical deployment architecture.</p>
</td>
<td width="280">
<p>The deployment guide includes step by step procedure to <a href="./Provisioning.html">provision AWS resources</a> and a <a href="AWS%20ECS%20Deployment.html">script to automatically deploy assets to AWS</a></p>
<p>The deployment guide includes step by step procedure to <a href="../Provisioning.html">provision AWS resources</a> and a <a href="AWS%20ECS%20Deployment.html">script to automatically deploy assets to AWS</a></p>
</td>
</tr>
<tr>
Expand All @@ -428,7 +428,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide contains prescriptive guidance for testing and troubleshooting.</p>
</td>
<td width="280">
<p>The deployment guide contains a <a href="./User%20guide.html">user guide section.</a></p>
<p>The deployment guide contains a <a href="../User%20guide.html">user guide section.</a></p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -457,7 +457,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides step-by-step instructions for how to assess and monitor the health and proper function of the application.</p>
</td>
<td width="546">
<p>This is detailed in the <a href="./Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
<p>This is detailed in the <a href="../Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -486,7 +486,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>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.</p>
</td>
<td width="546">
<p>This is detailed in the <a href="./Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
<p>This is detailed in the <a href="../Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -548,7 +548,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides prescriptive guidance on managing AWS service limits.</p>
</td>
<td width="546">
<p>&nbsp;This is detailed in the <a href="./Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
<p>&nbsp;This is detailed in the <a href="../Lifecycle_management.html#backup-and-recovery">lifecycle management</a> section.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -628,7 +628,7 @@ This is the summary of the Reflectance Processor FTR for ECSreview based on [AWS
<p>The deployment guide provides details on how to receive support.</p>
</td>
<td width="546">
<p>User support is described <a href="./User%20guide.html#support">here</a></p>
<p>User support is described <a href="../User%20guide.html#support">here</a></p>
</td>
</tr>
<tr>
Expand Down
4 changes: 2 additions & 2 deletions Deploy/AWS Lambda Deployment.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ nav_order: 1

The following sections will guide you through the steps to setup a GitAction workflow to deploy the Reflectance Datacube processor on [AWS Lambda](https://aws.amazon.com/fr/pm/lambda/?gclid=Cj0KCQjw0MexBhD3ARIsAEI3WHKHFIwpgJl1S8X0Brj35ffpgeqoxbbMuqzSE_5beUpN6smZBPArjosaApH_EALw_wcB&trk=e0e0d4be-47fe-4336-ab69-7eece7f3d36e&sc_channel=ps&ef_id=Cj0KCQjw0MexBhD3ARIsAEI3WHKHFIwpgJl1S8X0Brj35ffpgeqoxbbMuqzSE_5beUpN6smZBPArjosaApH_EALw_wcB:G:s&s_kwcid=AL!4422!3!652240143523!e!!g!!amazon%20lambda!19878797032!147151597893).

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

Expand Down

0 comments on commit dd8e233

Please sign in to comment.