From 5e18bd4d1ef622073d567230a4f86afc807391b9 Mon Sep 17 00:00:00 2001 From: Carlisia Thompson Date: Fri, 26 Feb 2021 08:35:29 -0800 Subject: [PATCH] (low priority) Add port fwding info to Tilt doc (#3424) * Add port fwding info to Tilt doc Signed-off-by: Carlisia * Fix spelling Signed-off-by: Carlisia * Fix capitalization Signed-off-by: Carlisia --- site/content/docs/main/tilt.md | 12 ++++++++---- site/content/docs/v1.5/tilt.md | 13 +++++++++---- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/site/content/docs/main/tilt.md b/site/content/docs/main/tilt.md index 057e66598..1221b36b9 100644 --- a/site/content/docs/main/tilt.md +++ b/site/content/docs/main/tilt.md @@ -129,13 +129,17 @@ spec: Here are two ways to use MinIO as the storage: -1) As a MinIO instance running inside your cluster +1) As a MinIO instance running inside your cluster (don't do this for production!) In the `tilt-settings.json` file, set `"setup-minio": true`. This will configure a Kubernetes deployment containing a running -instance of Minio inside your cluster. There are [extra steps](contributions/minio/#expose-minio-outside-your-cluster-with-a-service) -necessary to expose Minio outside the cluster. Note: with this setup, when your cluster is terminated so is the storage and any backup/restore in it. +instance of MinIO inside your cluster. There are [extra steps](contributions/minio/#expose-minio-outside-your-cluster-with-a-service) +necessary to expose MinIO outside the cluster. -2) As a standalone MinIO instance running locally in a Docker container + To access this storage, you will need to expose MinIO outside the cluster by forwarding the MinIO port to the local machine using kubectl port-forward -n svc/minio 9000. Update the BSL configuration to use that as its "public URL" by adding `publicUrl: http://localhost:9000` to the BSL config. This is necessary to do things like download a backup file. + + Note: with this setup, when your cluster is terminated so is the storage and any backup/restore in it. + +1) As a standalone MinIO instance running locally in a Docker container See [these instructions](https://github.com/vmware-tanzu/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod. diff --git a/site/content/docs/v1.5/tilt.md b/site/content/docs/v1.5/tilt.md index 622166bf5..1221b36b9 100644 --- a/site/content/docs/v1.5/tilt.md +++ b/site/content/docs/v1.5/tilt.md @@ -27,6 +27,7 @@ files in this directory are gitignored so you may configure your setup according 1. Clone any [provider plugin(s)](https://velero.io/plugins/) you want to make changes to and deploy (optional, must be configured to be deployed by the Velero Tilt's setup, [more info below](#provider-plugins)) Note: To properly configure any plugin you use, please follow the plugin's documentation. + ## Getting started ### tl;dr @@ -128,13 +129,17 @@ spec: Here are two ways to use MinIO as the storage: -1) As a MinIO instance running inside your cluster +1) As a MinIO instance running inside your cluster (don't do this for production!) In the `tilt-settings.json` file, set `"setup-minio": true`. This will configure a Kubernetes deployment containing a running -instance of Minio inside your cluster. There are [extra steps](contributions/minio/#expose-minio-outside-your-cluster-with-a-service) -necessary to expose Minio outside the cluster. Note: with this setup, when your cluster is terminated so is the storage and any backup/restore in it. +instance of MinIO inside your cluster. There are [extra steps](contributions/minio/#expose-minio-outside-your-cluster-with-a-service) +necessary to expose MinIO outside the cluster. -2) As a standalone MinIO instance running locally in a Docker container + To access this storage, you will need to expose MinIO outside the cluster by forwarding the MinIO port to the local machine using kubectl port-forward -n svc/minio 9000. Update the BSL configuration to use that as its "public URL" by adding `publicUrl: http://localhost:9000` to the BSL config. This is necessary to do things like download a backup file. + + Note: with this setup, when your cluster is terminated so is the storage and any backup/restore in it. + +1) As a standalone MinIO instance running locally in a Docker container See [these instructions](https://github.com/vmware-tanzu/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod.