MinIO Quickstart (#16080)

* Add the quickstart draft * Add context for new article/support * style tweaks * add link to toc * Small edits * Детали! * Add description * Staging is my friend * Apply suggestions from code review * All about that space * Formatting tweaks are almost there * Balance is key. * Last spacing attempts for now * Another spacing adjustment * Remove redirect * Apply suggestions from code review * Apply @lucascosti's stellar input Co-authored-by: Lucas Costi <[email protected]> * spacing dance & Merge branch 'minio-setup-3067' of github.com:github/docs-internal into minio-setup-3067 * Apply @lucascosti's stellar input Co-authored-by: Lucas Costi <[email protected]> * rewrite intro * Fix intro * Change order of intro * intro tweak * Apply suggestions from code review Co-authored-by: Kayla Ngan <[email protected]> * Apply URL example for next steps * Tighten up text Co-authored-by: Lucas Costi <[email protected]> Co-authored-by: Kayla Ngan <[email protected]>
github · Nov 18, 2020 · 78fd8d7 · 78fd8d7
1 parent 01dcee9
commit 78fd8d7
Show file tree

Hide file tree

Showing 3 changed files with 135 additions and 1 deletion.
diff --git a/content/admin/packages/configuring-third-party-storage-for-packages.md b/content/admin/packages/configuring-third-party-storage-for-packages.md
@@ -13,7 +13,7 @@ versions:
 
 {% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}.
 
-At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analogous information for your MinIO configuration.
+At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analogous information for your MinIO configuration. Before configuring third-party storage for {% data variables.product.prodname_registry %} on {% data variables.product.prodname_dotcom %}, you must set up a bucket with your third-party storage provider. For more information on installing and running a MinIO bucket to use with {% data variables.product.prodname_registry %}, see the "[Quickstart for configuring MinIO storage](/admin/packages/quickstart-for-configuring-minio-storage)."
 
 For the best experience, we recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage.
 

diff --git a/content/admin/packages/index.md b/content/admin/packages/index.md
@@ -10,5 +10,6 @@ versions:
 {% data reusables.package_registry.packages-ghes-release-stage %}
 
 {% link_with_intro /enabling-github-packages-for-your-enterprise %}
+{% link_with_intro /quickstart-for-configuring-minio-storage %}
 {% link_with_intro /configuring-packages-support-for-your-enterprise %}
 {% link_with_intro /configuring-third-party-storage-for-packages %}
diff --git a/content/admin/packages/quickstart-for-configuring-minio-storage.md b/content/admin/packages/quickstart-for-configuring-minio-storage.md
@@ -0,0 +1,133 @@
+---
+title: Quickstart for configuring MinIO storage
+intro: 'Set up MinIO as a storage provider for using {% data variables.product.prodname_registry %} on your enterprise.'
+versions:
+  enterprise-server: '>=2.22'
+---
+
+{% data reusables.package_registry.packages-ghes-release-stage %}
+
+Before you can enable and configure {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %}, you need to prepare your third-party storage solution.
+
+MinIO offers object storage with support for the S3 API and {% data variables.product.prodname_registry %} on your enterprise.
+
+This quickstart shows you how to set up MinIO using Docker for use with {% data variables.product.prodname_registry %} but you have other options for managing MinIO besides Docker. For more information about MinIO, see the official [MinIO docs](https://docs.min.io/).
+
+### 1. Choose a MinIO mode for your needs 
+
+| MinIO mode | Optimized for | Storage infrastructure required | 
+|----|----|----|
+| Standalone MinIO (on a single host) | Fast setup |  N/A | 
+| MinIO as a NAS gateway |  NAS (Network-attached storage)| NAS devices |
+| Clustered MinIO (also called Distributed MinIO)|  Data security | Storage servers running in a cluster |
+
+For more information about your options, see the official [MinIO docs](https://docs.min.io/).
+
+### 2. Install, run, and sign in to MinIO
+
+1. Set up your preferred environment variables for MinIO.
+
+    These examples use `MINIO_DIR`:
+    ```shell
+    $ export MINIO_DIR=$(pwd)/minio
+    $ mkdir -p $MINIO_DIR
+    ```
+
+2. Install MinIO.
+
+    ```shell
+    $ docker pull minio/minio
+    ```
+    For more information, see the official "[MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide)."
+
+3. Sign in to MinIO using your MinIO access key and secret.
+
+    {% linux %}
+    ```shell
+    $ export MINIO_ACCESS_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
+    # this one is actually a secret, so careful
+    $ export MINIO_SECRET_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
+    ```
+    {% endlinux %}
+
+    {% mac %}
+    ```shell
+    $ export MINIO_ACCESS_KEY=$(cat /dev/urandom | LC_CTYPE=C tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
+    # this one is actually a secret, so careful
+    $ export MINIO_SECRET_KEY=$(cat /dev/urandom | LC_CTYPE=C tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
+    ```
+    {% endmac %}
+
+    You can access your MinIO keys using the environment variables: 
+
+    ```shell
+    $ echo $MINIO_ACCESS_KEY
+    $ echo $MINIO_SECRET_KEY
+    ```
+
+4. Run MinIO in your chosen mode.
+
+   * Run MinIO using Docker on a single host:
+
+     ```shell
+     $ docker run -p 9000:9000 \
+             -v $MINIO_DIR:/data \
+             -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \
+             -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \
+             minio/minio server /data
+     ```
+
+     For more information, see "[MinIO Docker Quickstart guide](https://docs.min.io/docs/minio-docker-quickstart-guide.html)."
+
+   * Run MinIO using Docker as a NAS gateway:
+
+     This setup is useful for deployments where there is already a NAS you want to use as the backup storage for {% data variables.product.prodname_registry %}.
+
+     ```shell
+     $ docker run -p 9000:9000 \
+             -v $MINIO_DIR:/data \
+             -e "MINIO_ACCESS_KEY=$MINIO_ACCESS_KEY" \
+             -e "MINIO_SECRET_KEY=$MINIO_SECRET_KEY" \
+             minio/minio gateway nas /data
+     ```
+
+     For more information, see "[MinIO Gateway for NAS](https://docs.min.io/docs/minio-gateway-for-nas.html)."
+
+   * Run MinIO using Docker as a cluster. This MinIO deployment uses several hosts and MinIO's erasure coding for the strongest data protection. To run MinIO in a cluster mode, see the "[Distributed MinIO Quickstart Guide](https://docs.min.io/docs/distributed-minio-quickstart-guide.html).
+
+### 3. Create your MinIO bucket for {% data variables.product.prodname_registry %}
+
+1. Install the MinIO client.  
+
+    ```shell
+    $ docker pull minio/mc
+    ```
+
+2. Create a bucket with a host URL that {% data variables.product.prodname_ghe_server %} can access.
+
+   * Local deployments example:
+
+     ```shell
+     $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @localhost:9000"
+     $ docker run minio/mc <em>BUCKET-NAME</em>
+     ```
+
+     This example can be used for MinIO standalone or MinIO as a NAS gateway.
+
+   * Clustered deployments example:
+
+     ```shell
+     $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @minioclustername.example.com:9000"
+     $ docker run minio/mc mb packages
+     ```
+
+
+### Next steps
+
+To finish configuring storage for {% data variables.product.prodname_registry %}, you'll need to copy the MinIO storage URL:
+
+  ```
+  echo "http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY}@minioclustername.example.com:9000"
+  ```
+
+For the next steps, see "[Configuring third-party storage for packages](/admin/packages/configuring-third-party-storage-for-packages)."