Skip to content

Commit

Permalink
[doc] Fix git links to match tag
Browse files Browse the repository at this point in the history
  • Loading branch information
rconway committed Sep 28, 2023
1 parent 90b3158 commit 50e668d
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/eoepca/resource-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ client-secret: <my-secret>

To obtain the _Client Credentials_ required by the `uma-user-agent` it is necessary to register a client with the `login-service`, or use the credentials for an existing client.

A [helper script](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/bin/register-client) is provided to register a basic client and obtain the required credentials. The script is available in the [`deployment-guide` repository](https://github.com/EOEPCA/deployment-guide), and can be obtained as follows...
A [helper script](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/bin/register-client) is provided to register a basic client and obtain the required credentials. The script is available in the [`deployment-guide` repository](https://github.com/EOEPCA/deployment-guide), and can be obtained as follows...

```bash
git clone [email protected]:EOEPCA/deployment-guide
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/creodias-deployment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CREODIAS Deployment

Based upon our development experiences on CREODIAS, there is a wrapper script [`creodias`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/creodias/creodias) with particular customisations suited to the [CREODIAS](https://creodias.eu/) infrastructure and data offering. The customisations are expressed through [environment variables](scripted-deployment.md#environment-variables) that are captured in the file [`creodias-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/creodias/creodias-options).
Based upon our development experiences on CREODIAS, there is a wrapper script [`creodias`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/creodias/creodias) with particular customisations suited to the [CREODIAS](https://creodias.eu/) infrastructure and data offering. The customisations are expressed through [environment variables](scripted-deployment.md#environment-variables) that are captured in the file [`creodias-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/creodias/creodias-options).

These scripts are examples that can be seen as a starting point, from which they can be adapted to your needs.

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/data-access-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A deployment wrapper script has been prepared for a 'data access' deployment - that is focused on the Resource Catalogue and Data Access services.

The script [`deploy/data-access/data-access`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/data-access/data-access) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/data-access/data-access-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/data-access/data-access-options).
The script [`deploy/data-access/data-access`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/data-access/data-access) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/data-access/data-access-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/data-access/data-access-options).

The data-access deployment applies the following configuration:

Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart/exploitation-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A deployment wrapper script has been prepared for an 'exploitation' deployment - that provides deployment/execution of processing via the ADES, supported by Resource Catalogue and Data Access services.

The script [`deploy/exploitation/exploitation`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/exploitation/exploitation) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/exploitation/exploitation-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/exploitation/exploitation-options).
The script [`deploy/exploitation/exploitation`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/exploitation/exploitation) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/exploitation/exploitation-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/exploitation/exploitation-options).

The exploitation deployment applies the following configuration:

Expand Down Expand Up @@ -39,7 +39,7 @@ The Data Access View Server is accessed at the endpoint `data-access-open.<domai
Section [Processing](processing-deployment.md) provides an example of a [simple self-contained processing deployment and execution](processing-deployment.md#example-requests), and [access to the processing results](processing-deployment.md#processing-results).

In addition to the `snuggs` example, the file [`deploy/samples/requests/processing/s-expression.http`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/samples/requests/processing/s-expression.http) has been prepared to exploit data that has been registered within the _Resource Catalogue_ and _Data Access_ services.
In addition to the `snuggs` example, the file [`deploy/samples/requests/processing/s-expression.http`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/samples/requests/processing/s-expression.http) has been prepared to exploit data that has been registered within the _Resource Catalogue_ and _Data Access_ services.

First the input data for processing must be harvested into the resource management services.<br>
**_Sentinel-2 data on 2nd Sept 2020..._**
Expand All @@ -48,7 +48,7 @@ First the input data for processing must be harvested into the resource manageme
./deploy/bin/harvest ./deploy/samples/harvester/config-Sentinel2-2020.09.02.yaml
```

Then the [`s-expression.http`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/samples/requests/processing/s-expression.http) file provides sample requests for **_OGC API Processes_** operations:
Then the [`s-expression.http`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/samples/requests/processing/s-expression.http) file provides sample requests for **_OGC API Processes_** operations:

* List Processes
* Deploy Process
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/processing-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A deployment wrapper script has been prepared for a 'processing' deployment - that is focused on the ADES and the deployment/execution of processing jobs.

The script [`deploy/processing/processing`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/processing/processing) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/processing/processing-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/processing/processing-options).
The script [`deploy/processing/processing`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/processing/processing) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/processing/processing-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/processing/processing-options).

The processing deployment applies the following configuration:

Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart/scripted-deployment.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Scripted Deployment

The Scripted Deployment provides a demonstration of an example deployment, and can found in the subdirectory [`deployment-guide/deploy`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/eoepca/eoepca.sh) of the source repository for this guide...
The Scripted Deployment provides a demonstration of an example deployment, and can found in the subdirectory [`deployment-guide/deploy`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/eoepca/eoepca.sh) of the source repository for this guide...

```bash
git clone https://github.com/EOEPCA/deployment-guide \
&& cd deployment-guide \
&& ls deploy
```

The script [`deploy/eoepca/eoepca.sh`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/eoepca/eoepca.sh) acts as an entry-point to the full system deployment. In order to tailor the deployment for your target environment, the script is configured through environment variables and command-line arguments. By default the script assumes deployment to a local minikube.
The script [`deploy/eoepca/eoepca.sh`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/eoepca/eoepca.sh) acts as an entry-point to the full system deployment. In order to tailor the deployment for your target environment, the script is configured through environment variables and command-line arguments. By default the script assumes deployment to a local minikube.

!!! note
The scripted deployment assumes that installation of the [Prerequisite Tooling](../cluster/prerequisite-tooling.md) has been performed.
Expand All @@ -28,7 +28,7 @@ The Protection step is split from Deployment as there are some manual steps to b

## Configuration

The script [`deploy/eoepca/eoepca.sh`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/eoepca/eoepca.sh) is configured by some environment variables and command-line arguments.
The script [`deploy/eoepca/eoepca.sh`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/eoepca/eoepca.sh) is configured by some environment variables and command-line arguments.

### Environment Variables

Expand Down Expand Up @@ -237,7 +237,7 @@ A json response is returned, in which the field `id_token` provides the user ID

### Using `create-workspace` helper script

As an aide there is a helper script [`create-workspace`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/bin/create-workspace). The script is available in the [`deployment-guide` repository](https://github.com/EOEPCA/deployment-guide), and can be obtained as follows...
As an aide there is a helper script [`create-workspace`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/bin/create-workspace). The script is available in the [`deployment-guide` repository](https://github.com/EOEPCA/deployment-guide), and can be obtained as follows...

```bash
git clone [email protected]:EOEPCA/deployment-guide
Expand Down Expand Up @@ -279,7 +279,7 @@ Before initiating a fresh deployment, if a prior deployment has been attempted,
During the deployment a client of the Authorisation Server is registered, and its credentials stored for reuse in the file `client.yaml`. Once the cluster has been destroyed, then these client credentials become stale and so should be removed to avoid polluting subsequent deployments...<br>
`rm -rf ./deploy/eoepca/client.yaml`

There is a helper script [`clean`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/cluster/clean) that can be used for steps 2 and 3 above, (the script does not delete the cluster).
There is a helper script [`clean`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/cluster/clean) that can be used for steps 2 and 3 above, (the script does not delete the cluster).
```bash
./deploy/cluster/clean
```
4 changes: 2 additions & 2 deletions docs/quickstart/simple-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A deployment wrapper script has been prepared for a 'simple' deployment - designed to get a core local deployment of the primary servies.

The script [`deploy/simple/simple`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/simple/simple) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/simple/simple-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/simple/simple-options).
The script [`deploy/simple/simple`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/simple/simple) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/simple/simple-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/simple/simple-options).

The simple deployment applies the following configuration:

Expand All @@ -24,7 +24,7 @@ See section [Deployment](scripted-deployment.md#deployment) for more details reg

## Protection

See section [Protection](scripted-deployment.md#protection) for more details regarding the protection of the deployed services - which, for the simple deployment, is performed via the script [`deploy/simple/simple-protection`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/simple/simple-protection)...
See section [Protection](scripted-deployment.md#protection) for more details regarding the protection of the deployed services - which, for the simple deployment, is performed via the script [`deploy/simple/simple-protection`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/simple/simple-protection)...

```
./deploy/simple/simple-protection
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/userman-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A deployment wrapper script has been prepared for a 'user management' deployment - that is focused on the _Login Service_, _PDP_ and _User Profile_.

The script [`deploy/userman/userman`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/userman/userman) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/userman/userman-options`](https://github.com/EOEPCA/deployment-guide/blob/main/deploy/userman/userman-options).
The script [`deploy/userman/userman`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/userman/userman) achieves this by appropriate [configuration of the environment variables](scripted-deployment.md#environment-variables), before launching the [eoepca.sh deployment script](scripted-deployment.md#command-line-arguments). The deployment configuration is captured in the file [`deploy/userman/userman-options`](https://github.com/EOEPCA/deployment-guide/blob/eoepca-v1.3/deploy/userman/userman-options).

The user-management deployment applies the following configuration:

Expand Down

0 comments on commit 50e668d

Please sign in to comment.