From 43b393f617608ee5c9d2c6d640fc46e0e36a7a72 Mon Sep 17 00:00:00 2001 From: Matthew Fisher Date: Wed, 12 Apr 2017 14:58:42 -0700 Subject: [PATCH] clarify helm serve's intent A lot of community members are looking at `helm serve` as a production webserver to host their charts. There are much better solutions out there like s3, wabs or gcs for cloud storage and nginx, haproxy or apache for DIY dedicated web servers. Steering users in the right direction will help users make the right decision when it comes to serving their charts in production. --- cmd/helm/serve.go | 7 +++++++ docs/helm/helm_serve.md | 9 ++++++++- docs/man/man1/helm_serve.1 | 14 ++++++++++++-- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/cmd/helm/serve.go b/cmd/helm/serve.go index 4f78ed4b4..fd3e3eb8f 100644 --- a/cmd/helm/serve.go +++ b/cmd/helm/serve.go @@ -34,6 +34,13 @@ This command starts a local chart repository server that serves charts from a lo The new server will provide HTTP access to a repository. By default, it will scan all of the charts in '$HELM_HOME/repository/local' and serve those over the local IPv4 TCP port (default '127.0.0.1:8879'). + +This command is intended to be used for educational and testing purposes only. +It is best to rely on a dedicated web server or a cloud-hosted solution like +Google Cloud Storage for production use. + +See https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories +for more information on hosting chart repositories in a production setting. ` type serveCmd struct { diff --git a/docs/helm/helm_serve.md b/docs/helm/helm_serve.md index e809bd5c2..a78e52a8c 100644 --- a/docs/helm/helm_serve.md +++ b/docs/helm/helm_serve.md @@ -12,6 +12,13 @@ The new server will provide HTTP access to a repository. By default, it will scan all of the charts in '$HELM_HOME/repository/local' and serve those over the local IPv4 TCP port (default '127.0.0.1:8879'). +This command is intended to be used for educational and testing purposes only. +It is best to rely on a dedicated web server or a cloud-hosted solution like +Google Cloud Storage for production use. + +See https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories +for more information on hosting chart repositories in a production setting. + ``` helm serve @@ -38,4 +45,4 @@ helm serve ### SEE ALSO * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 11-Mar-2017 +###### Auto generated by spf13/cobra on 12-Apr-2017 diff --git a/docs/man/man1/helm_serve.1 b/docs/man/man1/helm_serve.1 index 37a2617ca..6cb80593e 100644 --- a/docs/man/man1/helm_serve.1 +++ b/docs/man/man1/helm_serve.1 @@ -1,4 +1,4 @@ -.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" +.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" "" .nh .ad l @@ -22,6 +22,16 @@ The new server will provide HTTP access to a repository. By default, it will scan all of the charts in '$HELM\_HOME/repository/local' and serve those over the local IPv4 TCP port (default '127.0.0.1:8879'). +.PP +This command is intended to be used for educational and testing purposes only. +It is best to rely on a dedicated web server or a cloud\-hosted solution like +Google Cloud Storage for production use. + +.PP +See +\[la]https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md#hosting-chart-repositories\[ra] +for more information on hosting chart repositories in a production setting. + .SH OPTIONS .PP @@ -66,4 +76,4 @@ the local IPv4 TCP port (default '127.0.0.1:8879'). .SH HISTORY .PP -11\-Mar\-2017 Auto generated by spf13/cobra +12\-Apr\-2017 Auto generated by spf13/cobra