From 4660f91ce590907ab719b8868eff500d3aab335f Mon Sep 17 00:00:00 2001 From: Pierre HUBERT Date: Thu, 6 Mar 2025 21:05:34 +0100 Subject: [PATCH] Improve dev documentation --- docs/DevelopmentSetup.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/DevelopmentSetup.md b/docs/DevelopmentSetup.md index e2f3019..68c9926 100644 --- a/docs/DevelopmentSetup.md +++ b/docs/DevelopmentSetup.md @@ -3,10 +3,10 @@ This guide will present you how to prepare your computer to update features of M ## Install Rust -As this project has been written using Rust, you will need to install it prior working on MinioK8SBucket. Please follow the official instructions: https://www.rust-lang.org/tools/install +As this project has been written using Rust, you will need to install it prior working on MinioK8SBucket. Please follow the official instructions: [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install) ## Install Minikube -First, you need to install Minikube on your computer to have a K8S environment. In order to do this, please follow the official instructions: https://minikube.sigs.k8s.io/docs/start +First, you need to install Minikube on your computer to have a K8S environment. In order to do this, please follow the official instructions: [https://minikube.sigs.k8s.io/docs/start](https://minikube.sigs.k8s.io/docs/start) ## Start Minikube @@ -51,13 +51,13 @@ You will then need to deploy Minio in Minikube. Apply the Minio deployment locat minikube kubectl -- apply -f yaml/minio-dev-deployment.yml ``` -Check for launching of pod: +Wait for the pod to become ready: ```bash minikube kubectl -- get pods -w ``` -Check for the availability of the service: +Check for the availability of the service that expose Minio to your host computer: ```bash minikube kubectl -- get services @@ -71,12 +71,12 @@ kubernetes ClusterIP 10.96.0.1 443/TCP minio LoadBalancer 10.103.82.87 127.0.0.1 9000:30656/TCP,9090:31369/TCP 6m40s ``` -You should be able to access minio at the following address: http://127.0.0.1:9090 +You should be able to access minio at the following address: [http://127.0.0.1:9090](http://127.0.0.1:9090/) -Minio API should be available at: http://127.0.0.1:9000/ +Minio API should be available at: [http://127.0.0.1:9000/](http://127.0.0.1:9000/) ## Deploy CRD -You will need then to deploy the Custom Resource Definitions of MinioK8S bucket using the following command: +You will need then to deploy the Custom Resource Definitions of MinioK8SBucket using the following command: ```bash minikube kubectl -- apply -f yaml/crd.yaml @@ -96,4 +96,14 @@ You should be able to create a first bucket using the following command: minikube kubectl -- apply -f test/test-outside-cluster.yaml ``` +The bucket should then appear in buckets list: + +```bash +minikube kubectl -- get buckets +``` +``` +NAME AGE +first-bucket 8m43s +``` + Have fun working for MinioK8SBucket! \ No newline at end of file