|
1 | | -# Quick Start |
| 1 | +# Quick Start - Boostrap a deployment on minikube |
2 | 2 |
|
3 | | -Boostrap a deployment on minikube: https://github.com/eoap/dev-platform-eoap/tree/main/ogc-api-processes-with-zoo |
| 3 | +## Requirements |
| 4 | + |
| 5 | +Before you begin, make sure you have the following tools installed and set up on your local environment: |
| 6 | + |
| 7 | +### Skaffold |
| 8 | + |
| 9 | +Skaffold is used to build, push, and deploy your application to Kubernetes. |
| 10 | + |
| 11 | +You can install it by following the instructions [here](https://skaffold.dev/docs/install/#standalone-binary). |
| 12 | + |
| 13 | +### Helm |
| 14 | + |
| 15 | +Helm is a package manager for Kubernetes, enabling you to manage Kubernetes applications easily. |
| 16 | + |
| 17 | +You can install it by following the steps [here](https://helm.sh/docs/intro/install/). |
| 18 | + |
| 19 | +### Minikube |
| 20 | + |
| 21 | +Minikube runs a local Kubernetes cluster, ideal for development and testing. |
| 22 | + |
| 23 | +You can install it by following the guide [here](https://minikube.sigs.k8s.io/docs/start). |
| 24 | + |
| 25 | +Start your minikube instance with: |
| 26 | + |
| 27 | +``` |
| 28 | +minikube start |
| 29 | +``` |
| 30 | + |
| 31 | +### Optional requirements |
| 32 | + |
| 33 | +#### Kubectl |
| 34 | + |
| 35 | +Kubectl is a command-line tool for interacting with Kubernetes clusters. It allows you to manage and inspect cluster resources. While not strictly required, it's highly recommended for debugging and interacting with your Kubernetes environment. |
| 36 | + |
| 37 | +You can install it by following the instructions [here](https://kubernetes.io/docs/tasks/tools/#kubectl). |
| 38 | + |
| 39 | +#### OpenLens |
| 40 | + |
| 41 | +OpenLens is a graphical user interface for managing and monitoring Kubernetes clusters. It provides a visual way to interact with resources. |
| 42 | + |
| 43 | +While it's optional, it can significantly improve your workflow. You can download it [here](https://github.com/MuhammedKalkan/OpenLens?tab=readme-ov-file#installation). |
| 44 | + |
| 45 | +### Add the helm repositories |
| 46 | + |
| 47 | +``` |
| 48 | +helm repo add localstack https://helm.localstack.cloud |
| 49 | +helm repo add zoo-project https://zoo-project.github.io/charts/ |
| 50 | +``` |
| 51 | + |
| 52 | +### Checking the requirements |
| 53 | + |
| 54 | +After installing these tools, ensure they are available in your terminal by running the following commands: |
| 55 | + |
| 56 | +```bash |
| 57 | +skaffold version |
| 58 | +helm version |
| 59 | +minikube version |
| 60 | +``` |
| 61 | + |
| 62 | +If all commands return a version, you’re good to go! |
| 63 | + |
| 64 | +## Clone the repository |
| 65 | + |
| 66 | +``` |
| 67 | +git clone https://github.com/eoap/dev-platform-eoap/ |
| 68 | +cd dev-platform-eoap/ |
| 69 | +``` |
| 70 | + |
| 71 | +## Run the _Mastering Earth Observation Application Packaging with CWL_ module on minikube with: |
| 72 | + |
| 73 | +``` |
| 74 | +cd ogc-api-processes-with-zoo |
| 75 | +skaffold dev |
| 76 | +``` |
| 77 | + |
| 78 | +Wait for the deployment to stablize (1-2 minutes) and the open your browser on the link printed, usually http://127.0.0.1:8000. |
| 79 | + |
| 80 | +## Follow the tutorial |
| 81 | + |
| 82 | +This tutorial is designed for developers, scientists, and Earth observation enthusiasts who want to get acquainted with the ZOO-Project OGC API Processes implementation to deploy and run Application Packages as web services |
| 83 | + |
| 84 | +* Documentation available at: https://eoap.github.io/ogc-api-processes-with-zoo/ |
| 85 | +* Repository available at: https://github.com/eoap/ogc-api-processes-with-zoo/ |
0 commit comments