Merge pull request 'Update Rust crate schemars to 1.1.0' (#243) from renovate/schemars-1.x into master

Reviewed-on: #191

.drone.yml

@@ -4,17 +4,39 @@ type: docker
 name: default
 
 steps:
-- name: cargo_check
+- name: fetch_dependencies
   image: rust
+  volumes:
+    - name: rust_registry
+      path: /usr/local/cargo/registry
+  commands:
+    - cargo fetch
+
+- name: code_quality
+  image: rust
+  volumes:
+    - name: rust_registry
+      path: /usr/local/cargo/registry
+  depends_on:
+    - fetch_dependencies
+  commands:
+    - rustup component add clippy
+    - cargo clippy -- -D warnings
+
+- name: test
+  image: rust
+  depends_on:
+      - code_quality
+  volumes:
+      - name: rust_registry
+        path: /usr/local/cargo/registry
   commands:
   - wget -O /usr/bin/minio https://dl.min.io/server/minio/release/linux-amd64/minio
   - wget -O /usr/bin/mc https://dl.min.io/client/mc/release/linux-amd64/mc
   - chmod +x /usr/bin/minio /usr/bin/mc
-  - rustup component add clippy
-  - cargo clippy -- -D warnings
   - cargo test
 
-- name: doc
+- name: build_doc
   image: python
   environment:
     AWS_ACCESS_KEY_ID:
@@ -39,3 +61,7 @@ steps:
   - aws configure set default.s3.signature_version s3v4
   # Upload to bucket
   - cd public && aws --endpoint-url https://s3.communiquons.org s3 sync . s3://miniok8sbucketsoperator-website
+
+volumes:
+  - name: rust_registry
+    temp: {}

Cargo.toml

@@ -6,17 +6,17 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-log = "0.4.21"
-env_logger = "0.11.3"
-anyhow = "1.0.82"
-serde = { version = "1.0.198", features = ["derive"] }
-serde_json = "1.0.115"
-schemars = "0.8.17"
-tokio = { version = "1.37.0", features = ["full"] }
-kube = { version = "0.97.0", features = ["runtime", "derive"] }
-k8s-openapi = { version = "0.23.0", features = ["v1_31"] }
-futures = "0.3.30"
-thiserror = "2.0.7"
-rand = "0.8.5"
+log = "0.4.28"
+env_logger = "0.11.8"
+anyhow = "1.0.100"
+serde = { version = "1.0.228", features = ["derive"] }
+serde_json = "1.0.145"
+schemars = "1.1.0"
+tokio = { version = "1.48.0", features = ["full"] }
+kube = { version = "2.0.1", features = ["runtime", "derive"] }
+k8s-openapi = { version = "0.26.0", features = ["v1_31"] }
+futures = "0.3.31"
+thiserror = "2.0.17"
+rand = "0.9.2"
 mktemp = "0.5.1"
-reqwest = "0.12.3"
+reqwest = "0.12.24"

docs/DevelopmentSetup.md

@@ -0,0 +1,109 @@
+# Setup for development
+This guide will present you how to prepare your computer to update features of MinioK8SBucket
+
+
+## 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](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](https://minikube.sigs.k8s.io/docs/start)
+
+
+## Start Minikube
+You will then need to start Minikube using the following command:
+
+```bash
+minikube start
+```
+
+You can then make sure that Minikube is working properly:
+
+```
+minikube kubectl get nodes
+```
+
+You should get a response similar to this one:
+
+```
+NAME       STATUS   ROLES           AGE     VERSION
+minikube   Ready    control-plane   2m16s   v1.32.0
+```
+
+## Clone repository
+Clone this repository using:
+
+```bash
+https://gitea.communiquons.org/pierre/MinioK8sBuckets
+```
+
+!!! note "Gitea account request"
+    If you want to get a Gitea account to make pull request on this repository, you will need to contact me at: `pierre.git@communiquons.org`
+
+## Deploy Minio
+First, enable Minikube tunnel:
+```bash
+minikube tunnel --bind-address '127.0.0.1' 
+```
+
+You will then need to deploy Minio in Minikube. Apply the Minio deployment located at the in MinioK8SBucket repository:
+
+```bash
+minikube kubectl -- apply -f yaml/minio-dev-deployment.yml
+```
+
+Wait for the pod to become ready:
+
+```bash
+minikube kubectl -- get pods -w
+```
+
+Check for the availability of the service that expose Minio to your host computer:
+
+```bash
+minikube kubectl -- get services
+```
+
+You should get a result similar to this one:
+
+```
+NAME         TYPE           CLUSTER-IP     EXTERNAL-IP   PORT(S)                         AGE
+kubernetes   ClusterIP      10.96.0.1      <none>        443/TCP                         31m
+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](http://127.0.0.1:9090/)
+
+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 MinioK8SBucket using the following command:
+
+```bash
+minikube kubectl -- apply -f yaml/crd.yaml
+```
+
+## Run operator
+You can then run the project using the following command:
+
+```bash
+cargo fmt && cargo clippy && RUST_LOG=debug cargo run --
+```
+
+## Create a first bucket
+You should be able to create a first bucket using the following command:
+
+```bash
+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!

docs/README.md

@@ -62,7 +62,7 @@ spec:
 
 
 ## Create a bucket
-You are not ready to create your first bucket!
+You are now ready to create your first bucket!
 
 Here is a basic bucket example:
 
@@ -113,4 +113,4 @@ spec:
     # compliance => nobody can bypass the policy
     # governance => users with privileges might bypass policy restrictions
     mode: compliance
-```
+```

renovate.json

@@ -1,9 +1,3 @@
 {
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "packageRules": [
-    {
-      "matchUpdateTypes": ["minor", "patch"],
-      "automerge": true
-    }
-  ]
-}
+  "extends": ["local>renovate/presets"]
+}

src/main.rs

@@ -77,7 +77,7 @@ async fn apply_bucket(b: &MinioBucket, client: &Client) -> anyhow::Result<()> {
             );
 
             // The secret needs to be created
-            let new_user = MinioUser::gen_random();
+            let new_user = MinioUser::gen_random(&b.spec.name);
             create_secret(
                 &secrets,
                 &b.spec.secret,

src/minio.rs

@@ -44,9 +44,9 @@ pub struct MinioUser {
 }
 
 impl MinioUser {
-    pub fn gen_random() -> Self {
+    pub fn gen_random(prefix: &str) -> Self {
         Self {
-            username: rand_str(SECRET_MINIO_BUCKET_ACCESS_LEN),
+            username: format!("{prefix}_{}", rand_str(SECRET_MINIO_BUCKET_ACCESS_LEN)),
             password: rand_str(SECRET_MINIO_BUCKET_SECRET_LEN),
         }
     }
@@ -164,7 +164,7 @@ impl MinioService {
 
     /// Get bucket name prefixed by mc alias name
     fn absolute_bucket_name(&self, name: &str) -> String {
-        format!("{}/{name}", MC_ALIAS_NAME)
+        format!("{MC_ALIAS_NAME}/{name}")
     }
 
     /// Execute a minio mc command
@@ -172,7 +172,7 @@ impl MinioService {
     where
         A: DeserializeOwned,
     {
-        log::debug!("exec_mc_cmd with args {:?}", args);
+        log::debug!("exec_mc_cmd with args {args:?}");
 
         let conf_dir = temp::create_temp_dir()?;
         let global_flags = ["--config-dir", conf_dir.to_str().unwrap(), "--json"];
@@ -354,7 +354,7 @@ impl MinioService {
         let bucket_name = self.absolute_bucket_name(bucket);
 
         let res = if let Some(quota) = &quota {
-            let quota = format!("{}B", quota);
+            let quota = format!("{quota}B");
             self.exec_mc_cmd::<BasicMinioResult>(&[
                 "quota",
                 "set",
@@ -447,7 +447,7 @@ impl MinioService {
                         "governance" => RetentionType::Governance,
                         "compliance" => RetentionType::Compliance,
                         o => {
-                            log::error!("Unknown retention type: {}", o);
+                            log::error!("Unknown retention type: {o}");
                             return Ok(None);
                         }
                     },
@@ -1099,7 +1099,7 @@ mod test {
         let srv = MinioTestServer::start().await.unwrap();
         let service = srv.as_service();
 
-        let user = MinioUser::gen_random();
+        let user = MinioUser::gen_random("policy_user");
 
         assert!(!service.user_list().await.unwrap().contains(&user.username));
         service.user_apply(&user).await.unwrap();
@@ -1113,7 +1113,7 @@ mod test {
         let srv = MinioTestServer::start().await.unwrap();
         let service = srv.as_service();
 
-        let user = MinioUser::gen_random();
+        let user = MinioUser::gen_random("attach_policy_user");
 
         service.user_apply(&user).await.unwrap();
         service

src/minio_test_server.rs

@@ -25,7 +25,7 @@ impl MinioTestServer {
 
         let root_user = rand_str(30);
         let root_password = rand_str(30);
-        let api_port = (2000 + rand::thread_rng().next_u64() % 5000) as u16;
+        let api_port = (2000 + rand::rng().next_u64() % 5000) as u16;
         log::info!(
             "Spwan a new Minio server on port {} with root credentials {}:{}",
             api_port,

src/utils.rs

@@ -1,11 +1,6 @@
-use rand::distributions::Alphanumeric;
-use rand::Rng;
+use rand::distr::{Alphanumeric, SampleString};
 
 /// Generate a random string of a given size
 pub fn rand_str(len: usize) -> String {
-    rand::thread_rng()
-        .sample_iter(&Alphanumeric)
-        .take(len)
-        .map(char::from)
-        .collect()
+    Alphanumeric.sample_string(&mut rand::rng(), len)
 }

test/test-outside-cluster.yaml

@@ -12,7 +12,7 @@ kind: MinioInstance
 metadata:
   name: my-minio-instance
 spec:
-  endpoint: http://localhost:9000/
+  endpoint: http://localhost:9000
   credentials: minio-root
 ---
 apiVersion: "communiquons.org/v1"
@@ -22,4 +22,4 @@ metadata:
 spec:
   instance: my-minio-instance
   name: first-bucket
-  secret: first-bucket-secret
+  secret: first-bucket-secret

yaml/minio-dev-deployment.yml

@@ -0,0 +1,89 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: minio
+  labels:
+    app: minio
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: minio
+  template:
+    metadata:
+      labels:
+        app: minio
+    spec:
+      volumes:
+        - name: data
+          persistentVolumeClaim:
+            claimName: minio
+      containers:
+        - name: minio
+          image: minio/minio
+          imagePullPolicy: Always
+          ports:
+            - containerPort: 9000
+              protocol: TCP
+              name: api
+            - containerPort: 9090
+              protocol: TCP
+              name: console
+          args:
+            - server
+            - /data
+            - --console-address
+            - ":9090"
+          env:
+            - name: MINIO_ROOT_USER
+              value: minioadmin
+            - name: MINIO_ROOT_PASSWORD
+              value: minioadmin
+          volumeMounts:
+            - mountPath: "/data"
+              name: data
+
+---
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: minio
+spec:
+  storageClassName: manual
+  accessModes:
+    - ReadWriteOnce
+  capacity:
+    storage: 5Gi
+  hostPath:
+    path: /data/minio/
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: minio
+spec:
+  storageClassName: manual
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 3Gi
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: minio
+  labels:
+    app: minio
+spec:
+  type: LoadBalancer
+  selector:
+    app: minio
+  ports:
+    - name: api
+      port: 9000
+      targetPort: api
+    - name: console
+      port: 9090
+      targetPort: console
+  externalTrafficPolicy: Local