From bab4c90c45f13452d1ea8d73ee66ff3d4c3399a9 Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Wed, 24 Oct 2018 23:09:31 -0700 Subject: [PATCH] Fix broken links in docs (#6700) --- docs/metrics/healthcheck/README.md | 2 +- docs/sts/README.md | 2 +- docs/sts/client-grants.md | 2 +- docs/sts/etcd.md | 6 +-- docs/sts/opa.md | 2 +- docs/sts/putobject.rego | 8 ++++ docs/sts/sts.env | 1 + docs/sts/wso2.md | 2 +- docs/zh_CN/gateway/azure.md | 4 -- docs/zh_CN/gateway/gcs.md | 4 -- docs/zh_CN/orchestration/kubernetes/README.md | 4 +- docs/zh_CN/orchestration/minikube/README.md | 46 ------------------- docs/zh_CN/shared-backend/README.md | 2 +- pkg/madmin/README.md | 2 +- 14 files changed, 20 insertions(+), 67 deletions(-) create mode 100644 docs/sts/putobject.rego delete mode 100644 docs/zh_CN/orchestration/minikube/README.md diff --git a/docs/metrics/healthcheck/README.md b/docs/metrics/healthcheck/README.md index 4ecce1e50..efe27ad0e 100644 --- a/docs/metrics/healthcheck/README.md +++ b/docs/metrics/healthcheck/README.md @@ -20,4 +20,4 @@ Platforms like Kubernetes *do not* forward traffic to a pod until its readiness ### Configuration example -Sample `liveness` and `readiness` probe configuration in a Kubernetes `yaml` file can be found [here](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml). +Sample `liveness` and `readiness` probe configuration in a Kubernetes `yaml` file can be found [here](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes/minio-standalone-deployment.yaml). diff --git a/docs/sts/README.md b/docs/sts/README.md index 4351d6dd8..b42df6b6d 100644 --- a/docs/sts/README.md +++ b/docs/sts/README.md @@ -11,7 +11,7 @@ Following are advantages for using temporary credentials: - Temporary credentials have a limited lifetime, there is no need to rotate them or explicitly revoke them. Expired temporary credentials cannot be reused. ## Identity Federation -[**Client grants**](https://github.com/minio/minio/blob/master/docs/sts/client-grants.md) - Let applications request `client_grants` using any well-known third party identity provider such as KeyCloak, WSO2. This is known as the client grants approach to temporary access. Using this approach helps clients keep Minio credentials to be secured. Minio STS client grants supports WSO2, Keycloak. +[**Client grants**](https://github.com/minio/minio/blob/master/docs/sts/client-grants.md) - Let applications request `client_grants` using any well-known third party identity provider such as KeyCloak, WSO2. This is known as the client grants approach to temporary access. Using this approach helps clients keep Minio credentials to be secured. Minio STS supports client grants, tested against identity providers such as WSO2, KeyCloak. ## Get started In this document we will explain in detail on how to configure all the prerequisites, primarily WSO2, OPA (open policy agent). diff --git a/docs/sts/client-grants.md b/docs/sts/client-grants.md index ec3e0f32f..6737f77b3 100644 --- a/docs/sts/client-grants.md +++ b/docs/sts/client-grants.md @@ -56,7 +56,7 @@ $ mc admin config get myminio ``` Testing with an example -> Obtaining client ID and secrets follow [WSO2 configuring documentation](./wso2.md) +> Obtaining client ID and secrets follow [WSO2 configuring documentation](https://github.com/minio/minio/blob/master/docs/sts/wso2.md) ``` go run full-example.go -cid PoEgXP6uVO45IsENRngDXj5Au5Ya -csec eKsw6z8CtOJVBtrOWvhRWL4TUCga diff --git a/docs/sts/etcd.md b/docs/sts/etcd.md index e52f72230..4781cd7ce 100644 --- a/docs/sts/etcd.md +++ b/docs/sts/etcd.md @@ -6,7 +6,7 @@ etcd is a distributed key value store that provides a reliable way to store data - Docker 18.03 or above, refer here for [installation](https://docs.docker.com/install/). ### 2. Start etcd -etcd uses [gcr.io/etcd-development/etcd](gcr.io/etcd-development/etcd) as a primary container registry. +etcd uses [gcr.io/etcd-development/etcd](https://console.cloud.google.com/gcr/images/etcd-development/GLOBAL/etcd) as a primary container registry. ``` rm -rf /tmp/etcd-data.tmp && mkdir -p /tmp/etcd-data.tmp && \ @@ -37,7 +37,7 @@ minio server /data ``` ### 5. Test with Minio STS API -Assuming that you have configured Minio server to support STS API by following the doc [Minio STS Quickstart Guide](https://docs.minio.io/docs/minio-sts-quickstart-guide) and once you have obtained the JWT from WSO2 as mentioned in [WSO2 Quickstart Guide](https://docs.minio.io/docs/wso2-quickstart-guide). +Assuming that you have configured Minio server to support STS API by following the doc [Minio STS Quickstart Guide](https://docs.minio.io/docs/minio-sts-quickstart-guide) and once you have obtained the JWT from WSO2 as mentioned in [WSO2 Quickstart Guide](https://github.com/minio/minio/blob/master/docs/sts/wso2.md). ``` go run full-example.go -cid PoEgXP6uVO45IsENRngDXj5Au5Ya -csec eKsw6z8CtOJVBtrOWvhRWL4TUCga @@ -50,7 +50,7 @@ go run full-example.go -cid PoEgXP6uVO45IsENRngDXj5Au5Ya -csec eKsw6z8CtOJVBtrOW } ``` -These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://docs.minio.io/docs/api-assume-role-with-client-grants). +These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://github.com/minio/minio/blob/master/docs/sts/client-grants.md). ## Explore Further - [Minio STS Quickstart Guide](https://docs.minio.io/docs/minio-sts-quickstart-guide) diff --git a/docs/sts/opa.md b/docs/sts/opa.md index a26693f3b..8ead88c10 100644 --- a/docs/sts/opa.md +++ b/docs/sts/opa.md @@ -78,7 +78,7 @@ go run full-example.go -cid PoEgXP6uVO45IsENRngDXj5Au5Ya -csec eKsw6z8CtOJVBtrOW } ``` -These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://docs.minio.io/docs/api-assume-role-with-client-grants). +These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://github.com/minio/minio/blob/master/docs/sts/client-grants.md). ## Explore Further - [Minio STS Quickstart Guide](https://docs.minio.io/docs/minio-sts-quickstart-guide) diff --git a/docs/sts/putobject.rego b/docs/sts/putobject.rego new file mode 100644 index 000000000..4eb0248fd --- /dev/null +++ b/docs/sts/putobject.rego @@ -0,0 +1,8 @@ +package httpapi.authz + +import input as http_api + +allow { + input.action = "s3:PutObject" + input.owner = false +} diff --git a/docs/sts/sts.env b/docs/sts/sts.env index 4ab65ed4d..793f578f1 100644 --- a/docs/sts/sts.env +++ b/docs/sts/sts.env @@ -2,3 +2,4 @@ export MINIO_ACCESS_KEY=minio export MINIO_SECRET_KEY=minio123 export MINIO_IAM_JWKS_URL=http://localhost:9763/oauth2/jwks export MINIO_IAM_OPA_URL=http://localhost:8181/v1/data/httpapi/authz +export MINIO_ETCD_ENDPOINTS=localhost:2379 diff --git a/docs/sts/wso2.md b/docs/sts/wso2.md index 011678ff7..0df990df9 100644 --- a/docs/sts/wso2.md +++ b/docs/sts/wso2.md @@ -83,7 +83,7 @@ go run full-example.go -cid PoEgXP6uVO45IsENRngDXj5Au5Ya -csec eKsw6z8CtOJVBtrOW } ``` -These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://docs.minio.io/docs/api-assume-role-with-client-grants). +These credentials can now be used to perform Minio API operations, these credentials automatically expire in 1hr. To understand more about credential expiry duration and client grants STS API read further [here](https://github.com/minio/minio/blob/master/docs/sts/client-grants.md). ## Explore Further - [Minio STS Quickstart Guide](https://docs.minio.io/docs/minio-sts-quickstart-guide) diff --git a/docs/zh_CN/gateway/azure.md b/docs/zh_CN/gateway/azure.md index 9da6d15c2..131079988 100644 --- a/docs/zh_CN/gateway/azure.md +++ b/docs/zh_CN/gateway/azure.md @@ -37,11 +37,7 @@ mc ls myazure [2017-02-26 22:10:11 PST] 0B test-container1/ ``` -### 已知的限制 -[限制](https://github.com/minio/minio/blob/master/docs/gateway/azure-limitations.md) - ## 了解更多 - [`mc` 命令行接口](https://docs.minio.io/cn/minio-client-quickstart-guide) - [`aws` 命令行接口](https://docs.minio.io/cn/aws-cli-with-minio) -- [`minfs` 文件系统接口](https://docs.minio.io/cn/minfs-quickstart-guide) - [`minio-go` Go SDK](https://docs.minio.io/cn/golang-client-quickstart-guide) diff --git a/docs/zh_CN/gateway/gcs.md b/docs/zh_CN/gateway/gcs.md index f239149b8..8aece45b8 100644 --- a/docs/zh_CN/gateway/gcs.md +++ b/docs/zh_CN/gateway/gcs.md @@ -52,12 +52,8 @@ mc ls mygcs [2017-02-26 22:10:11 PST] 0B test-container1/ ``` -### 已知的限制 -[限制](https://github.com/minio/minio/blob/master/docs/gateway/gcs-limitations.md) - ## 了解更多 - [`mc` 命令行接口](https://docs.minio.io/cn/minio-client-quickstart-guide) - [`aws` 命令行接口](https://docs.minio.io/cn/aws-cli-with-minio) -- [`minfs` 文件系统接口](https://docs.minio.io/cn/minfs-quickstart-guide) - [`minio-go` Go SDK](https://docs.minio.io/cn/golang-client-quickstart-guide) diff --git a/docs/zh_CN/orchestration/kubernetes/README.md b/docs/zh_CN/orchestration/kubernetes/README.md index dbaf40b23..76710f110 100644 --- a/docs/zh_CN/orchestration/kubernetes/README.md +++ b/docs/zh_CN/orchestration/kubernetes/README.md @@ -4,9 +4,7 @@ Kubernetes的部署和状态集提供了在独立，分布式或共享模式下 - Minio [Helm](https://helm.sh) Chart通过一个简单的命令即可提供自定义而且简单的Minio部署。更多关于Minio Helm部署的资料，请访问[这里](#prerequisites). -- 你也可以浏览Kubernetes [Minio示例](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes-yaml/README.md) ，通过`.yaml`文件来部署Minio。 - -- 如果您想在Kubernetes上开始使用Minio，而无需创建真正的容器集群，您也可以使用Minikube [deploy Minio locally](https://raw.githubusercontent.com/minio/minio/master/docs/orchestration/minikube/README.md)。 +- 你也可以浏览Kubernetes [Minio示例](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes/README.md) ，通过`.yaml`文件来部署Minio。 ## 1. 前提条件 diff --git a/docs/zh_CN/orchestration/minikube/README.md b/docs/zh_CN/orchestration/minikube/README.md deleted file mode 100644 index 27b09953b..000000000 --- a/docs/zh_CN/orchestration/minikube/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# 使用minikube在本地部署分布式Minio - [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) [![codecov](https://codecov.io/gh/minio/minio/branch/master/graph/badge.svg)](https://codecov.io/gh/minio/minio) - -Minikube在计算机的VM中运行单节点Kubernetes集群。 这样可以轻松地在计算机上本地运行的Kubernetes上部署分布式Minio服务器。 - -## 1. 前提条件 - -本机已经安装[Minikube](https://github.com/kubernetes/minikube/blob/master/README.md#installation) 和 [`kubectl`](https://kubernetes.io/docs/user-guide/prereqs/) - - -## 2. 步骤 - -* 下载 `minio_distributed.sh` 和 `statefulset.yaml` - -```sh -wget https://raw.githubusercontent.com/minio/minio/master/docs/orchestration/minikube/minio_distributed.sh -wget https://raw.githubusercontent.com/minio/minio/master/docs/orchestration/minikube/statefulset.yaml -``` - -* 在命令提示符下执行`minio_distributed.sh`脚本。 - -```sh -./minio_distributed.sh -``` - -脚本执行成功后，您应该会收到一个这样的输出 - -```sh -service "minio-public" created -service "minio" created -statefulset "minio" created -``` -这意味着Minio部署在您当地的Minikube安装中。 - -请注意，服务“minio-public”是一个[clusterIP]（https://kubernetes.io/docs/user-guide/services/#publishing-services---service-types）服务。 它在集群内部IP上暴露服务。 通过`kubectl port-forward`命令连接到Minio实例，执行 - -``` -kubectl port-forward minio-0 9000:9000 -``` - -Minio服务器现在可以在`http:// localhost:9000`访问，使用`statefulset.yaml`文件中所述的accessKey和secretKey。 - -## 3. 注意 - -Minikube目前不支持动态配置，因此我们手动创建PersistentVolumes（PV）和PersistentVolumeClaims（PVC）。 创建PV和PVC后，我们将调用`statefulset.yaml`配置文件来创建分布式的Minio设置。 -此设置在笔记本电脑/计算机上运行。 因此，只有一个磁盘用作所有minio实例PV的后端。 Minio将这些PV视为单独的磁盘，并报告可用存储不正确。 diff --git a/docs/zh_CN/shared-backend/README.md b/docs/zh_CN/shared-backend/README.md index 75997e471..2767bef5b 100644 --- a/docs/zh_CN/shared-backend/README.md +++ b/docs/zh_CN/shared-backend/README.md @@ -17,7 +17,7 @@ Minio共享模式是为了解决在真实场景中存在的一些问题，而且 ## 1. 前提条件 -安装Minio - [Minio快速入门](https://docs.minio.io/cn/minio). +安装Minio - [Minio快速入门](https://docs.minio.io/cn/). ## 2. 在共享后端存储上运行Minio diff --git a/pkg/madmin/README.md b/pkg/madmin/README.md index bc25a17d4..b2b7dffd9 100644 --- a/pkg/madmin/README.md +++ b/pkg/madmin/README.md @@ -113,7 +113,7 @@ The sample output below shows the result of executing the above program against * [service-status.go](https://github.com/minio/minio/blob/master/pkg/madmin/examples/service-status.go) * [service-restart.go](https://github.com/minio/minio/blob/master/pkg/madmin/examples/service-restart.go) -* [service-set-credentials.go](https://github.com/minio/minio/blob/master/pkg/madmin/examples/service-set-credentials.go) +* [set-credentials.go](https://github.com/minio/minio/blob/master/pkg/madmin/examples/set-credentials.go) ## Contribute