Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.0 beta fixes #13

Merged
merged 8 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 19 additions & 20 deletions docs/building-blocks/application-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,6 @@

The **Application Hub** provides a suite of web-based tools, including JupyterLab for interactive analysis, Code Server for application development, and the capability to add user-defined interactive dashboards. It empowers users to manage and deliver work environments and tools for a wide range of tasks, such as developing, hosting, executing, and performing exploratory analysis of Earth Observation (EO) applications, all within a unified Cloud infrastructure.

## Table of Contents

1. [Introduction](#introduction)
2. [Architecture Overview](#architecture-overview)
3. [User Scenarios](#user-scenarios)
4. [Prerequisites](#prerequisites)
5. [Deployment](#deployment)
6. [Validation and Operation](#validation-and-operation)
7. [Uninstallation](#uninstallation)
8. [Further Reading](#further-reading)

***
## Introduction

Expand Down Expand Up @@ -127,20 +116,30 @@ bash configure-app-hub.sh

**Important Notes:**

- If you choose **not** to use `cert-manager`, you will need to create the TLS secrets manually before deploying.
- The required TLS secret names are:
- `app-hub-tls`
- For instructions on creating TLS secrets manually, please refer to the [Manual TLS Certificate Management](../infra/tls/manual-tls.md) section in the TLS Certificate Management Guide.

3. **Deploy the Application Hub Using Helm**
- **TLS Certificates**<br>
If you choose **not** to use `cert-manager`, you will need to create the TLS secrets manually before deploying.
- The required TLS secret names are:
- `app-hub-tls`
- For instructions on creating TLS secrets manually, please refer to the [Manual TLS Certificate Management](../infra/tls/manual-tls.md) section in the TLS Certificate Management Guide.
- **Node Selection**<br>
The generated helm values include a `nodeSelector` that identifies the target nodes for spawned workloads...<br>
```
nodeSelector:
key: "node-role.kubernetes.io/worker"
value: "true"
```
As required, this node selector must be adjusted according to your Kubernetes cluster.

1. **Deploy the Application Hub Using Helm**

Run the Helm install command using the generated values file:

```bash
helm install application-hub application-hub \
--version 2.0.59 \
helm repo add eoepca https://eoepca.github.io/helm-charts && \
helm repo update eoepca && \
helm upgrade -i application-hub eoepca/application-hub \
--version 2.1.0 \
--values generated-values.yaml \
--repo https://eoepca.github.io/helm-charts \
--namespace application-hub \
--create-namespace
```
Expand Down
14 changes: 0 additions & 14 deletions docs/building-blocks/application-quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@

The **Application Quality** Building Block supports the evolution of scientific algorithms from research projects to production environments. It provides tools for verifying non-functional requirements, including code quality, adherence to best practices, and performance optimisation through testing.

## Table of Contents

- [Application Quality Deployment Guide](#application-quality-deployment-guide)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Key Features](#key-features)
- [Prerequisites](#prerequisites)
- [Deployment Steps](#deployment-steps)
- [1. Run the Configuration Script](#1-run-the-configuration-script)
- [2. Deploy Application Quality Using Helm](#2-deploy-application-quality-using-helm)
- [Validation](#validation)
- [Uninstallation](#uninstallation)
- [Further Reading](#further-reading)

---

## Introduction
Expand Down
26 changes: 3 additions & 23 deletions docs/building-blocks/data-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,6 @@ The **Data Access** Building Block provides feature-rich and reliable interfaces

---

## Table of Contents

- [Data Access Deployment Guide](#data-access-deployment-guide)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Components Overview](#components-overview)
- [Prerequisites](#prerequisites)
- [Deployment Steps](#deployment-steps)
- [1. Run the Configuration Script](#1-run-the-configuration-script)
- [2. Deploy PostgreSQL Operator (pgo) and eoAPI](#2-deploy-postgresql-operator-pgo-and-eoapi)
- [3. Deploy Stacture](#3-deploy-stacture)
- [4. Deploy Tyk Gateway and Redis](#4-deploy-tyk-gateway-and-redis)
- [Monitoring the Deployment](#monitoring-the-deployment)
- [Accessing the Data Access Services](#accessing-the-data-access-services)
- [Validation](#validation)
- [Uninstallation](#uninstallation)
- [Further Reading](#further-reading)

---

## Introduction

The Data Access Building Block combines capabilities from two complementary libraries:
Expand Down Expand Up @@ -189,15 +169,15 @@ helm upgrade -i tyk-oss tyk-oss/tyk-oss \

---

### Monitoring the Deployment
### 5. Monitoring the Deployment

After deploying, you can monitor the status of the deployments:

```bash
kubectl get all -n data-access
```

### Accessing the Data Access Services
### 6. Accessing the Data Access Services

Once the deployment is complete and all pods are running, you can access the services:

Expand Down Expand Up @@ -236,7 +216,7 @@ bash validation.sh

---

### Uninstallation
## Uninstallation

To uninstall the Data Access Building Block and clean up associated resources:

Expand Down
15 changes: 3 additions & 12 deletions docs/building-blocks/mlops.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,6 @@

The **MLOps Building Block** provides support services for training machine learning models within the cloud platform. It orchestrates the training of ML models across popular frameworks, maintains a history of training runs with associated metrics, and manages the associated training data. This guide provides step-by-step instructions to deploy the MLOps Building Block within your Kubernetes cluster.

## Table of Contents

1. [Introduction](#introduction)
2. [Prerequisites](#prerequisites)
3. [Deployment Steps](#deployment-steps)
4. [Validation](#validation)
5. [Uninstallation](#uninstallation)
6. [Further Reading](#further-reading)
7. [Feedback](#feedback)

---

## Introduction
Expand Down Expand Up @@ -140,6 +130,7 @@ Deploy GitLab using the generated configuration file.
helm repo add gitlab https://charts.gitlab.io/ && \
helm repo update gitlab && \
helm upgrade -i gitlab gitlab/gitlab \
--version 8.1.8 \
--namespace gitlab \
--create-namespace \
--values gitlab/generated-values.yaml
Expand Down Expand Up @@ -176,7 +167,7 @@ bash utils/save-application-credentials-to-state.sh
### 6. Deploy SharingHub Using Helm

```bash
helm repo add sharinghub "git+https://github.com/csgroup-oss/sharinghub@deploy/helm?ref=main" && \
helm repo add sharinghub "git+https://github.com/csgroup-oss/sharinghub@deploy/helm?ref=0.3.0" && \
helm repo update sharinghub && \
helm upgrade -i sharinghub sharinghub/sharinghub \
--namespace sharinghub \
Expand All @@ -187,7 +178,7 @@ helm upgrade -i sharinghub sharinghub/sharinghub \
### 7. Deploy MLflow SharingHub Using Helm

```bash
helm repo add mlflow-sharinghub "git+https://github.com/csgroup-oss/mlflow-sharinghub@deploy/helm?ref=main" && \
helm repo add mlflow-sharinghub "git+https://github.com/csgroup-oss/mlflow-sharinghub@deploy/helm?ref=0.2.0" && \
helm repo update mlflow-sharinghub && \
helm upgrade -i mlflow-sharinghub mlflow-sharinghub/mlflow-sharinghub \
--namespace sharinghub \
Expand Down
16 changes: 1 addition & 15 deletions docs/building-blocks/processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,7 @@ The **Processing Building Block** provides deployment and execution of user-defi
* **OGC API Processes Engine**<br>
The **OGC API Processes Engine** provides an OGC API Processes execution engine through which users can deploy, manage, and execute OGC Application Packages. The OAPIP engine is provided by the [ZOO-Project](https://zoo-project.github.io/docs/intro.html#what-is-zoo-project) `zoo-project-dru` implementation - supporting OGC WPS 1.0.0/2.0.0 and OGC API Processes Parts 1 & 2.
* **openEO Engine**<br>
Coming soon.

## Table of Contents

- [Processing Building Block Deployment Guide](#processing-building-block-deployment-guide)
- [Table of Contents](#table-of-contents)
- [OGC API Processes Engine](#ogc-api-processes-engine)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deployment Steps](#deployment-steps)
- [Validation and Operation](#validation-and-operation)
- [Uninstallation](#uninstallation)
- [Additional Cleanup](#additional-cleanup)
- [Further Reading](#further-reading)
- [Feedback](#feedback)
_Coming soon_

***
## OGC API Processes Engine
Expand Down
16 changes: 1 addition & 15 deletions docs/building-blocks/resource-catalogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@

The **Resource Catalogue** is a standards-based Earth Observation (EO) metadata catalogue that supports OGC CSW, OGC API Records, STAC, and OpenSearch. It leverages **pycsw**, an open-source OGC-compliant metadata catalog server, to manage and serve EO data. This guide provides step-by-step instructions to deploy the Resource Catalogue within your Kubernetes cluster.


## Table of Contents

- [Resource Catalogue Deployment Guide](#resource-catalogue-deployment-guide)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Key Features](#key-features)
- [Interfaces](#interfaces)
- [Prerequisites](#prerequisites)
- [Deployment Steps](#deployment-steps)
- [Validation and Operation](#validation-and-operation)
- [Uninstallation](#uninstallation)
- [Further Reading](#further-reading)

***
## Introduction

Expand Down Expand Up @@ -50,7 +36,7 @@ Before deploying the Resource Catalogue, ensure you have the following:
| Helm | Version 3.5 or newer | [Installation Guide](https://helm.sh/docs/intro/install/) |
| kubectl | Configured for cluster access | [Installation Guide](https://kubernetes.io/docs/tasks/tools/) |
| Ingress | Properly installed | [Installation Guide](../infra/ingress-controller.md) |
| Cert Manager | Properly installed | [Installation Guide](../infra/tls/overview.mdkubernetes/) |
| Cert Manager | Properly installed | [Installation Guide](../infra/tls/overview.md) |

**Clone the Deployment Guide Repository:**

Expand Down
19 changes: 2 additions & 17 deletions docs/building-blocks/resource-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@ The **Resource Health** BB provides a flexible framework that allows platform us

---

## Table of Contents

- [Resource Health Deployment Guide](#resource-health-deployment-guide)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Components Overview](#components-overview)
- [Prerequisites](#prerequisites)
- [Deployment Steps](#deployment-steps)
- [Validation](#validation)
- [Uninstallation](#uninstallation)
- [Further Reading](#further-reading)

---

## Introduction

The **Resource Health Building Block** allows users to:
Expand Down Expand Up @@ -92,7 +78,7 @@ bash configure-resource-health.sh
2. **Deploy the Resource Health BB Using Helm:**

```bash
helm repo add resource-health "git+https://github.com/EOEPCA/resource-health?ref=main" && \
helm repo add resource-health "git+https://github.com/EOEPCA/resource-health?ref=2.0-beta" && \
helm repo update resource-health && \
helm upgrade -i resource-health resource-health/resource-health-reference-deployment \
--namespace resource-health \
Expand Down Expand Up @@ -137,8 +123,7 @@ bash validation.sh
To uninstall the Resource Health Building Block and clean up associated resources:

```bash
helm uninstall resource-health -n resource-health

helm uninstall resource-health -n resource-health && \
kubectl delete namespace resource-health
```

Expand Down
13 changes: 0 additions & 13 deletions docs/building-blocks/resource-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,6 @@ The **Resource Registration** Building Block enables data and metadata ingestion

---

## Table of Contents

1. [Introduction](#introduction)
2. [Components Overview](#components-overview)
3. [Prerequisites](#prerequisites)
4. [Deployment Steps](#deployment-steps)
5. [Validation](#validation)
6. [Uninstallation](#uninstallation)
7. [Further Reading](#further-reading)
8. [Scripts and Manifests](#scripts-and-manifests)

---

## Introduction

The **Resource Registration Building Block** manages resource ingestion into the platform for discovery, access and collaboration. It supports:
Expand Down
13 changes: 0 additions & 13 deletions docs/building-blocks/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,6 @@ The **Workspace** Building Block provides a comprehensive solution for storing a

---

## Table of Contents

1. [Introduction](#introduction)
2. [Components Overview](#components-overview)
3. [Prerequisites](#prerequisites)
4. [Deployment Steps](#deployment-steps)
5. [Validation](#validation)
6. [Uninstallation](#uninstallation)
7. [Further Reading](#further-reading)
8. [Scripts and Manifests](#scripts-and-manifests)

---

## Introduction

The **Workspace** Building Block provides a comprehensive environment where users can store, organise, and process data. It leverages Kubernetes and GitOps principles to create isolated and customisable workspaces for projects or individual users.
Expand Down
63 changes: 24 additions & 39 deletions docs/infra/container-registry.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,6 @@
# EOEPCA+ Container Registry Deployment Guide
The Container Registry stores and distributes container images for application development and deployment.

## Table of Contents

- [EOEPCA+ Container Registry Deployment Guide](#eoepca-container-registry-deployment-guide)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Architecture Overview](#architecture-overview)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Validation](#validation)
- [Operation](#operation)
- [Uninstallation](#uninstallation)
- [Further Reading](#further-reading)
- [Feedback](#feedback)
- [Enabling Optional Components](#enabling-optional-components)

***
## Introduction

Expand Down Expand Up @@ -117,6 +102,30 @@ helm upgrade -i harbor harbor/harbor \
- **Username**: `admin`
- **Password**: The password that was generated during configuration. (Alternatively check the `~/.eoepca/state` file)

***
### Enabling Optional Components

- **Trivy (Vulnerability Scanning)**:

```
trivy:
enabled: true
```

- **ChartMuseum (Helm Chart Repository)**:

```
chartmuseum:
enabled: true
```

- **Notary (Image Signing)**:

```
notary:
enabled: true
```

***
## Validation

Expand Down Expand Up @@ -227,27 +236,3 @@ To uninstall Harbor and clean up associated resources:
## Feedback

If you encounter any issues or have suggestions for improvement, please open an issue on the [EOEPCA+ Deployment Guide GitHub Repository](https://github.com/EOEPCA/deployment-guide/issues).

***
### Enabling Optional Components

- **Trivy (Vulnerability Scanning)**:

```
trivy:
enabled: true
```

- **ChartMuseum (Helm Chart Repository)**:

```
chartmuseum:
enabled: true
```

- **Notary (Image Signing)**:

```
notary:
enabled: true
```
Loading