helm/cmd/manager/router/context.go

/*
Copyright 2016 The Kubernetes Authors All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package router

import (
	"github.com/kubernetes/helm/cmd/manager/manager"
	helmhttp "github.com/kubernetes/helm/pkg/httputil"
	"github.com/kubernetes/helm/pkg/repo"
)

// Config holds the global configuration parameters passed into the router.
//
// Config is used concurrently. Once a config is created, it should be treated
// as immutable.
type Config struct {
	// Address is the host and port (:8080)
	Address string
	// MaxTemplateLength is the maximum length of a template.
	MaxTemplateLength int64
	// DeployerName is the deployer's DNS name
	DeployerName string
	// DeployerURL is the deployer's URL
	DeployerURL string
	// CredentialFile is the file to the credentials.
	CredentialFile string
	// CredentialSecrets tells the service to use a secrets file instead.
	CredentialSecrets bool
	// MongoName is the DNS name of the mongo server.
	MongoName string
	// MongoPort is the port for the MongoDB protocol on the mongo server.
	// It is a string for historical reasons.
	MongoPort string
	// MongoAddress is the name and port.
	MongoAddress string
}

// Context contains dependencies that are passed to each handler function.
//
// Context carries typed information, often scoped to interfaces, so that the
// caller's contract with the service is known at compile time.
//
// Members of the context must be concurrency safe.
type Context struct {
	Config *Config
	// Manager is a helm/manager/manager.Manager
	Manager            manager.Manager
	Encoder            helmhttp.Encoder
	CredentialProvider repo.ICredentialProvider
}