Capitalize tiller and kubernetes and helm in pkg docs strings.

reviewable/pr2601/r4
Justin Scott 8 years ago
parent 342c2e2526
commit 5524b8177c

@ -94,7 +94,7 @@ func (f Files) Glob(pattern string) Files {
}
// AsConfig turns a Files group and flattens it to a YAML map suitable for
// including in the `data` section of a kubernetes ConfigMap definition.
// including in the `data` section of a Kubernetes ConfigMap definition.
// Duplicate keys will be overwritten, so be aware that your filenames
// (regardless of path) should be unique.
//
@ -123,7 +123,7 @@ func (f Files) AsConfig() string {
}
// AsSecrets returns the value of a Files object as base64 suitable for
// including in the `data` section of a kubernetes Secret definition.
// including in the `data` section of a Kubernetes Secret definition.
// Duplicate keys will be overwritten, so be aware that your filenames
// (regardless of path) should be unique.
//

@ -40,7 +40,7 @@ func NewClient(opts ...Option) *Client {
return c.Option(opts...)
}
// Option configures the helm client with the provided options
// Option configures the Helm client with the provided options
func (h *Client) Option(opts ...Option) *Client {
for _, opt := range opts {
opt(&h.opts)

@ -34,7 +34,7 @@ import (
// path to example charts relative to pkg/helm.
const chartsDir = "../../docs/examples/"
// sentinel error to indicate to the helm client to not send the request to tiller.
// sentinel error to indicate to the Helm client to not send the request to tiller.
var errSkip = errors.New("test: skip")
// Verify ReleaseListOption's are applied to a ListReleasesRequest correctly.
@ -75,7 +75,7 @@ func TestListReleases_VerifyOptions(t *testing.T) {
ReleaseListNamespace(namespace),
}
// BeforeCall option to intercept helm client ListReleasesRequest
// BeforeCall option to intercept Helm client ListReleasesRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.ListReleasesRequest:
@ -124,7 +124,7 @@ func TestInstallRelease_VerifyOptions(t *testing.T) {
InstallDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client InstallReleaseRequest
// BeforeCall option to intercept Helm client InstallReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.InstallReleaseRequest:
@ -161,7 +161,7 @@ func TestDeleteRelease_VerifyOptions(t *testing.T) {
DeleteDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client DeleteReleaseRequest
// BeforeCall option to intercept Helm client DeleteReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.UninstallReleaseRequest:
@ -204,7 +204,7 @@ func TestUpdateRelease_VerifyOptions(t *testing.T) {
UpgradeDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client UpdateReleaseRequest
// BeforeCall option to intercept Helm client UpdateReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.UpdateReleaseRequest:
@ -244,7 +244,7 @@ func TestRollbackRelease_VerifyOptions(t *testing.T) {
RollbackDisableHooks(disableHooks),
}
// BeforeCall option to intercept helm client RollbackReleaseRequest
// BeforeCall option to intercept Helm client RollbackReleaseRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.RollbackReleaseRequest:
@ -273,7 +273,7 @@ func TestReleaseStatus_VerifyOptions(t *testing.T) {
Version: revision,
}
// BeforeCall option to intercept helm client GetReleaseStatusRequest
// BeforeCall option to intercept Helm client GetReleaseStatusRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.GetReleaseStatusRequest:
@ -302,7 +302,7 @@ func TestReleaseContent_VerifyOptions(t *testing.T) {
Version: revision,
}
// BeforeCall option to intercept helm client GetReleaseContentRequest
// BeforeCall option to intercept Helm client GetReleaseContentRequest
b4c := BeforeCall(func(_ context.Context, msg proto.Message) error {
switch act := msg.(type) {
case *tpb.GetReleaseContentRequest:

@ -75,9 +75,9 @@ func New(config clientcmd.ClientConfig) *Client {
// ResourceActorFunc performs an action on a single resource.
type ResourceActorFunc func(*resource.Info) error
// Create creates kubernetes resources from an io.reader
// Create creates Kubernetes resources from an io.reader.
//
// Namespace will set the namespace
// Namespace will set the namespace.
func (c *Client) Create(namespace string, reader io.Reader, timeout int64, shouldWait bool) error {
client, err := c.ClientSet()
if err != nil {
@ -147,7 +147,7 @@ func (c *Client) Build(namespace string, reader io.Reader) (Result, error) {
return result, scrubValidationError(err)
}
// Get gets kubernetes resources as pretty printed string
// Get gets Kubernetes resources as pretty printed string.
//
// Namespace will set the namespace
func (c *Client) Get(namespace string, reader io.Reader) (string, error) {
@ -210,9 +210,9 @@ func (c *Client) Get(namespace string, reader io.Reader) (string, error) {
// Update reads in the current configuration and a target configuration from io.reader
// and creates resources that don't already exists, updates resources that have been modified
// in the target configuration and deletes resources from the current configuration that are
// not present in the target configuration
// not present in the target configuration.
//
// Namespace will set the namespaces
// Namespace will set the namespaces.
func (c *Client) Update(namespace string, originalReader, targetReader io.Reader, force bool, recreate bool, timeout int64, shouldWait bool) error {
original, err := c.BuildUnstructured(namespace, originalReader)
if err != nil {
@ -281,9 +281,9 @@ func (c *Client) Update(namespace string, originalReader, targetReader io.Reader
return nil
}
// Delete deletes kubernetes resources from an io.reader
// Delete deletes Kubernetes resources from an io.reader.
//
// Namespace will set the namespace
// Namespace will set the namespace.
func (c *Client) Delete(namespace string, reader io.Reader) error {
infos, err := c.BuildUnstructured(namespace, reader)
if err != nil {

@ -18,7 +18,7 @@ package kube // import "k8s.io/helm/pkg/kube"
import "k8s.io/client-go/tools/clientcmd"
// GetConfig returns a kubernetes client config for a given context.
// GetConfig returns a Kubernetes client config for a given context.
func GetConfig(context string) clientcmd.ClientConfig {
rules := clientcmd.NewDefaultClientConfigLoadingRules()
rules.DefaultClientConfig = &clientcmd.DefaultClientConfig

@ -71,7 +71,7 @@ type Queryor interface {
// Driver is the interface composed of Creator, Updator, Deletor, Queryor
// interfaces. It defines the behavior for storing, updating, deleted,
// and retrieving tiller releases from some underlying storage mechanism,
// and retrieving Tiller releases from some underlying storage mechanism,
// e.g. memory, configmaps.
type Driver interface {
Creator

@ -37,11 +37,11 @@ import (
"k8s.io/helm/pkg/storage/driver"
)
// TillerNamespaceEnvVar is the environment variable name for the tiller
// TillerNamespaceEnvVar is the environment variable name for the Tiller
// namespace in the kubernetes cluster.
const TillerNamespaceEnvVar = "TILLER_NAMESPACE"
// DefaultTillerNamespace is the default namespace for tiller.
// DefaultTillerNamespace is the default namespace for Tiller.
const DefaultTillerNamespace = "kube-system"
// GoTplEngine is the name of the Go template engine, as registered in the EngineYard.

@ -27,7 +27,7 @@ import (
type Options struct {
CaCertFile string
// If either the KeyFile or CertFile is empty, ClientConfig() will not load them,
// preventing helm from authenticating to Tiller. They are required to be non-empty
// preventing Helm from authenticating to Tiller. They are required to be non-empty
// when calling ServerConfig, otherwise an error is returned.
KeyFile string
CertFile string

Loading…
Cancel
Save