From 02142cc5afa5b5131584dab6b9085d80fbd24a9a Mon Sep 17 00:00:00 2001 From: Antora via GitHub Actions Date: Tue, 4 Jun 2024 09:36:22 +0000 Subject: [PATCH] Update documentation rev 120b51b, 2024-06-04 09:36 --- 404.html | 3 + .../0.1/how-tos/create-releases.html | 4 + provider-minio/0.1/index.html | 4 + .../0.1/tutorials/getting-started.html | 4 + .../0.1/tutorials/installation.html | 4 + .../0.2/how-tos/create-releases.html | 4 + provider-minio/0.2/index.html | 4 + .../0.2/tutorials/getting-started.html | 4 + .../0.2/tutorials/installation.html | 4 + .../0.3/how-tos/create-releases.html | 265 +++++++++++++++ provider-minio/0.3/index.html | 227 +++++++++++++ .../0.3/tutorials/getting-started.html | 313 ++++++++++++++++++ .../0.3/tutorials/installation.html | 289 ++++++++++++++++ provider-minio/how-tos/create-releases.html | 6 +- provider-minio/index.html | 6 +- provider-minio/tutorials/getting-started.html | 6 +- provider-minio/tutorials/installation.html | 6 +- sitemap.xml | 40 ++- 18 files changed, 1177 insertions(+), 16 deletions(-) create mode 100644 provider-minio/0.3/how-tos/create-releases.html create mode 100644 provider-minio/0.3/index.html create mode 100644 provider-minio/0.3/tutorials/getting-started.html create mode 100644 provider-minio/0.3/tutorials/installation.html diff --git a/404.html b/404.html index 435c86e..7364f8d 100644 --- a/404.html +++ b/404.html @@ -83,6 +83,9 @@
  • master
    • +
  • + 0.3 +
  • 0.2
    • diff --git a/provider-minio/0.1/how-tos/create-releases.html b/provider-minio/0.1/how-tos/create-releases.html index 7848d9c..7b374ce 100644 --- a/provider-minio/0.1/how-tos/create-releases.html +++ b/provider-minio/0.1/how-tos/create-releases.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.1/index.html b/provider-minio/0.1/index.html index f84cb7a..b81b826 100644 --- a/provider-minio/0.1/index.html +++ b/provider-minio/0.1/index.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -154,6 +157,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.1/tutorials/getting-started.html b/provider-minio/0.1/tutorials/getting-started.html index 2642a99..ebea413 100644 --- a/provider-minio/0.1/tutorials/getting-started.html +++ b/provider-minio/0.1/tutorials/getting-started.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.1/tutorials/installation.html b/provider-minio/0.1/tutorials/installation.html index f9f008d..71a1c68 100644 --- a/provider-minio/0.1/tutorials/installation.html +++ b/provider-minio/0.1/tutorials/installation.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.2/how-tos/create-releases.html b/provider-minio/0.2/how-tos/create-releases.html index 4c0361c..8d01d5b 100644 --- a/provider-minio/0.2/how-tos/create-releases.html +++ b/provider-minio/0.2/how-tos/create-releases.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.2/index.html b/provider-minio/0.2/index.html index e35fc53..8d5c09b 100644 --- a/provider-minio/0.2/index.html +++ b/provider-minio/0.2/index.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -154,6 +157,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.2/tutorials/getting-started.html b/provider-minio/0.2/tutorials/getting-started.html index eeaf164..35d7d06 100644 --- a/provider-minio/0.2/tutorials/getting-started.html +++ b/provider-minio/0.2/tutorials/getting-started.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.2/tutorials/installation.html b/provider-minio/0.2/tutorials/installation.html index b2faec1..8862eb0 100644 --- a/provider-minio/0.2/tutorials/installation.html +++ b/provider-minio/0.2/tutorials/installation.html @@ -128,6 +128,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -155,6 +158,7 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    diff --git a/provider-minio/0.3/how-tos/create-releases.html b/provider-minio/0.3/how-tos/create-releases.html new file mode 100644 index 0000000..6632261 --- /dev/null +++ b/provider-minio/0.3/how-tos/create-releases.html @@ -0,0 +1,265 @@ + + + + + + + Create Releases :: Crossplane Provider Minio + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +
    +
    + +
    + +
    +

    Create Releases

    +
    +
    +
    +

    This repository contains GitHub releases.

    +
    +
    + + + + + +
    + + +
    +

    The PR template reminds you how to separate and label PRs.

    +
    +
    +
    +
    +
    +
    +

    Provider Release

    +
    +
    +

    Releasing a new version of the operator requires pushing a new Git tag, following the SemVer schema with a v prefix. +Optionally, for prereleases they may contain a ascending release candidate suffix with -rc#.

    +
    +
    +
    Example 1. Possible Operator Git tags
    +
    +
    +
      +
    • +

      v0.1.2

      +
      • +
    • +

      v1.4.0

      +
      • +
    • +

      v2.0.0-rc1

      +
      • +
    • +

      v2.0.0-rc2

      +
      • +
    +
    +
    +
    +
    +

    The changelog will be automatically created and is based on merged PRs. +The following labels must exist on a PR to be included in the changelog:

    +
    +
    +
      +
    • +

      area:operator

      +
      • +
    • +

      one of [bug, enhancement, documentation, change, breaking, dependency]

      +
      • +
    +
    +
    +
    +
    +
    +
    +
    + + + + + + + diff --git a/provider-minio/0.3/index.html b/provider-minio/0.3/index.html new file mode 100644 index 0000000..9c828d5 --- /dev/null +++ b/provider-minio/0.3/index.html @@ -0,0 +1,227 @@ + + + + + + + provider-minio :: Crossplane Provider Minio + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +
    +
    + +
    + +
    +

    provider-minio

    +

    Introduction

    +
    +

    Providre-minio is a Crossplane provider for minio.

    +
    +

    Documentation

    +
    +

    The documentation is inspired by the Divio’s documentation structure:

    +
    +
    +
    +
    Tutorials
    +
    +

    Learning-oriented: Simple lessons to learn about this project.

    +
    +
    How-to guides
    +
    +

    Problem-oriented: step-by-step guides to achieve a goal.

    +
    +
    Technical reference
    +
    +

    Information-oriented: explaining the inner ongoings.

    +
    +
    Explanation
    +
    +

    Understanding-oriented: puts this project in context.

    +
    +
    +
    +
    +
    +
    +
    + + + + + + + diff --git a/provider-minio/0.3/tutorials/getting-started.html b/provider-minio/0.3/tutorials/getting-started.html new file mode 100644 index 0000000..76fb174 --- /dev/null +++ b/provider-minio/0.3/tutorials/getting-started.html @@ -0,0 +1,313 @@ + + + + + + + Getting Started :: Crossplane Provider Minio + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +
    +
    + +
    + +
    +

    Getting Started

    +
    +
    +
    +

    This page describes how to create a new S3 bucket after you have installed the operator.

    +
    +
    +
    +
    +

    Prerequisites

    +
    +
    +
      +
    • +

      kubectl

      +
      • +
    • +

      Already running Kubernetes cluster

      +
      • +
    • +

      Installed minio

      +
      • +
    • +

      Installed Operator

      +
      • +
    +
    +
    +
    +
    +

    Steps

    +
    +
    +
      +
    1. +

      Create a file with the spec

      +
      +
      config.yaml
      +
      +
      apiVersion: v1
+kind: Secret
+metadata:
+  name: minio-secret
+  namespace: crossplane-system
+stringData:
+  AWS_ACCESS_KEY_ID: minioadmin (1)
+  AWS_SECRET_ACCESS_KEY: minioadmin (1)
+---
+apiVersion: minio.crossplane.io/v1
+kind: ProviderConfig
+metadata:
+  name: provider-config
+spec:
+  credentials:
+    apiSecretRef:
+      name: minio-secret
+      namespace: crossplane-system
+    source: InjectedIdentity
+  minioURL: http://minio-server.minio.svc:9000/ (2)
+status: {}
      +
      +
      +
      + + + + + + + + + +
      1Please adjust the credendials according to your minio installation
      2Please adjust the URL according to your minio installation
      +
      +
      2. +
    2. +

      Apply the spec in the cluster

      +
      +
      +
      kubectl apply -f config.yaml
      +
      +
      +
      3. +
    3. +

      Create a bucket

      +
      +
      bucket.yaml
      +
      +
      apiVersion: minio.crossplane.io/v1
+kind: Bucket
+metadata:
+  name: mybucket
+spec:
+  forProvider: {}
+  providerConfigRef:
+    name: provider-config
+status:
+  atProvider: {}
      +
      +
      +
      4. +
    4. +

      Wait until the operator has provisioned the user

      +
      +
      +
      kubectl apply -f bucket.yaml
+kubectl wait --for condition=Ready bucket/mybucket
      +
      +
      +
      5. +
    +
    +
    +
    +
    +
    +
    +
    + + + + + + + diff --git a/provider-minio/0.3/tutorials/installation.html b/provider-minio/0.3/tutorials/installation.html new file mode 100644 index 0000000..ac209e8 --- /dev/null +++ b/provider-minio/0.3/tutorials/installation.html @@ -0,0 +1,289 @@ + + + + + + + Installation :: Crossplane Provider Minio + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +
    +
    + +
    + +
    +

    Installation

    +
    +
    +
    +

    This tutorial goes through the steps required to get the operator up and running.

    +
    +
    +
    +
    +

    Prerequisites

    +
    +
    +
      +
    • +

      kubectl

      +
      • +
    • +

      A running Kubernetes cluster with cluster-admin permissions

      +
      • +
    +
    +
    +
    +
    +

    Steps

    +
    +
    +
      +
    1. +

      Install Crossplane chart

      +
      +
      +
      helm repo add crossplane https://charts.crossplane.io/stable
+helm upgrade --install crossplane crossplane/crossplane \
+  --create-namespace \
+  --namespace crossplane-system \
+  --set "args[1]='--enable-composition-revisions'" \
+  --set webhooks.enabled=true \
+  --wait
      +
      +
      +
      2. +
    2. +

      Install Minio Chart

      +
      +
      +
      helm repo add minio https://charts.min.io/ --force-update
+helm upgrade --install --create-namespace --namespace minio minio --version 5.0.7 minio/minio \
+	--values values.yaml (1)
      +
      +
      +
      + + + + + +
      1Please provide a values.yaml file that fits your purpose
      +
      +
      3. +
    3. +

      Install provider-minio

      +
      +
      +
      kubectl apply -f - <<EOF
+apiVersion: pkg.crossplane.io/v1
+kind: Provider
+metadata:
+  labels:
+    name: provider-minio
+  name: provider-minio
+spec:
+  package: ghcr.io/vshn/provider-minio/package:latest
+EOF
      +
      +
      +
      4. +
    +
    +
    +
    +
    +

    Conclusion

    +
    +
    +

    Now that you have the basic Provider running, it’s time to get started with deploying resources. +See Tutorial: Getting Started to get started.

    +
    +
    +
    +
    +
    +
    +
    + + + + + + + diff --git a/provider-minio/how-tos/create-releases.html b/provider-minio/how-tos/create-releases.html index b82cc09..89c5363 100644 --- a/provider-minio/how-tos/create-releases.html +++ b/provider-minio/how-tos/create-releases.html @@ -127,6 +127,9 @@

    Crossplane Provider Minio

  • master
    • +
  • + 0.3 +
  • 0.2
    • @@ -154,11 +157,12 @@

    Crossplane Provider Minio

    master + 0.3 0.2 0.1
    -
    Edit this Page
    +
    Edit this Page
    -
    Edit this Page
    +
    Edit this Page
    -
    Edit this Page
    +
    Edit this Page
    -
    Edit this Page
    +
    Edit this Page