update docstrings on Deployment, Service, and Secret

pull/3556/head
ryane 7 years ago
parent 61e88cbc41
commit 8bb4984f94
No known key found for this signature in database
GPG Key ID: EF68CF41D42A593D

@ -114,7 +114,9 @@ func createDeployment(client extensionsclient.DeploymentsGetter, opts *Options)
} }
// Deployment gets the deployment object that installs Tiller. // Deployment gets a deployment object that can be used to generate a manifest
// as a string. This object should not be submitted directly to the Kubernetes
// api
func Deployment(opts *Options) (*v1beta1.Deployment, error) { func Deployment(opts *Options) (*v1beta1.Deployment, error) {
dep, err := generateDeployment(opts) dep, err := generateDeployment(opts)
if err != nil { if err != nil {
@ -134,7 +136,8 @@ func createService(client corev1.ServicesGetter, namespace string) error {
return err return err
} }
// Service gets the service object that installs Tiller. // Service gets a service object that can be used to generate a manifest as a
// string. This object should not be submitted directly to the Kubernetes api
func Service(namespace string) *v1.Service { func Service(namespace string) *v1.Service {
svc := generateService(namespace) svc := generateService(namespace)
svc.TypeMeta = metav1.TypeMeta{ svc.TypeMeta = metav1.TypeMeta{
@ -346,7 +349,8 @@ func generateService(namespace string) *v1.Service {
return s return s
} }
// Secret gets the Tiller secret resource. // Secret gets a secret object that can be used to generate a manifest as a
// string. This object should not be submitted directly to the Kubernetes api
func Secret(opts *Options) (*v1.Secret, error) { func Secret(opts *Options) (*v1.Secret, error) {
secret, err := generateSecret(opts) secret, err := generateSecret(opts)
if err != nil { if err != nil {

Loading…
Cancel
Save