9e5bd5a2dc
After review, there are cases where having common requirements for namespaces and identifiers creates contention between applications. One example is that it is nice to have namespaces comply with domain name requirement, but that does not allow underscores, which are required for certain identifiers. The namespaces validation has been reverted to be in line with RFC 1035. Existing identifiers has been modified to allow simply alpha-numeric identifiers, while limiting adjacent separators. We may follow up tweaks for the identifier charset but this split should remove the hard decisions. Signed-off-by: Stephen J Day <stephen.day@docker.com>
62 lines
1.5 KiB
Go
62 lines
1.5 KiB
Go
package namespaces
|
|
|
|
import (
|
|
"os"
|
|
|
|
"github.com/containerd/containerd/errdefs"
|
|
"github.com/pkg/errors"
|
|
"golang.org/x/net/context"
|
|
)
|
|
|
|
const (
|
|
NamespaceEnvVar = "CONTAINERD_NAMESPACE"
|
|
Default = "default"
|
|
)
|
|
|
|
type namespaceKey struct{}
|
|
|
|
// WithNamespace sets a given namespace on the context
|
|
func WithNamespace(ctx context.Context, namespace string) context.Context {
|
|
ctx = context.WithValue(ctx, namespaceKey{}, namespace) // set our key for namespace
|
|
|
|
// also store on the grpc headers so it gets picked up by any clients that
|
|
// are using this.
|
|
return withGRPCNamespaceHeader(ctx, namespace)
|
|
}
|
|
|
|
// NamespaceFromEnv uses the namespace defined in CONTAINERD_NAMESPACE or
|
|
// default
|
|
func NamespaceFromEnv(ctx context.Context) context.Context {
|
|
namespace := os.Getenv(NamespaceEnvVar)
|
|
if namespace == "" {
|
|
namespace = Default
|
|
}
|
|
return WithNamespace(ctx, namespace)
|
|
}
|
|
|
|
// Namespace returns the namespace from the context.
|
|
//
|
|
// The namespace is not guaranteed to be valid.
|
|
func Namespace(ctx context.Context) (string, bool) {
|
|
namespace, ok := ctx.Value(namespaceKey{}).(string)
|
|
if !ok {
|
|
return fromGRPCHeader(ctx)
|
|
}
|
|
|
|
return namespace, ok
|
|
}
|
|
|
|
// NamespaceRequired returns the valid namepace from the context or an error.
|
|
func NamespaceRequired(ctx context.Context) (string, error) {
|
|
namespace, ok := Namespace(ctx)
|
|
if !ok || namespace == "" {
|
|
return "", errors.Wrapf(errdefs.ErrFailedPrecondition, "namespace is required")
|
|
}
|
|
|
|
if err := Validate(namespace); err != nil {
|
|
return "", errors.Wrap(err, "namespace validation")
|
|
}
|
|
|
|
return namespace, nil
|
|
}
|