mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-13 18:10:59 +00:00
a7df00c07a
[doc]: https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher Per this Go modules [doc] a repo or branch that's already tagged v2 or higher should increment the major version (e.g. go to v3) when releasing their first Go module-based packages. At the moment, the kustomize repo has these top level packages in the sigs.k8s.io/kustomize module: - `cmd` - holds main program for kustomize Conceivably someone can depend on this package for integration tests. - `internal` - intentionally unreleased subpackages - `k8sdeps` - an adapter wrapping k8s dependencies This exists only for use in pre-Go-modules kustomize-into-kubectl integration and won't live much longer (as everything involved is switching to Go modules). - `pkg` - kustomize packages for export This should shrink in later versions, since the surface area is too large, containing sub-packages that should be in 'internal'. - `plugin` - holds main programs for plugins This PR changes the top level go.mod file from ``` module sigs.k8s.io/kustomize ``` to ``` module sigs.k8s.io/kustomize/v3 ``` and adjusts all import statements to reflect the change.
89 lines
2.6 KiB
Go
89 lines
2.6 KiB
Go
// Copyright 2019 The Kubernetes Authors.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package ifc holds miscellaneous interfaces used by kustomize.
|
|
package ifc
|
|
|
|
import (
|
|
"sigs.k8s.io/kustomize/v3/pkg/gvk"
|
|
"sigs.k8s.io/kustomize/v3/pkg/types"
|
|
)
|
|
|
|
// Validator provides functions to validate annotations and labels
|
|
type Validator interface {
|
|
MakeAnnotationValidator() func(map[string]string) error
|
|
MakeAnnotationNameValidator() func([]string) error
|
|
MakeLabelValidator() func(map[string]string) error
|
|
MakeLabelNameValidator() func([]string) error
|
|
ValidateNamespace(string) []string
|
|
ErrIfInvalidKey(string) error
|
|
IsEnvVarName(k string) error
|
|
}
|
|
|
|
// Loader interface exposes methods to read bytes.
|
|
type Loader interface {
|
|
// Root returns the root location for this Loader.
|
|
Root() string
|
|
// New returns Loader located at newRoot.
|
|
New(newRoot string) (Loader, error)
|
|
// Load returns the bytes read from the location or an error.
|
|
Load(location string) ([]byte, error)
|
|
// Cleanup cleans the loader
|
|
Cleanup() error
|
|
// Validator validates data for use in various k8s fields.
|
|
Validator() Validator
|
|
// Loads pairs.
|
|
LoadKvPairs(args types.GeneratorArgs) ([]types.Pair, error)
|
|
}
|
|
|
|
// Kunstructured allows manipulation of k8s objects
|
|
// that do not have Golang structs.
|
|
type Kunstructured interface {
|
|
Map() map[string]interface{}
|
|
SetMap(map[string]interface{})
|
|
Copy() Kunstructured
|
|
GetFieldValue(string) (interface{}, error)
|
|
GetString(string) (string, error)
|
|
GetStringSlice(string) ([]string, error)
|
|
GetBool(path string) (bool, error)
|
|
GetFloat64(path string) (float64, error)
|
|
GetInt64(path string) (int64, error)
|
|
GetSlice(path string) ([]interface{}, error)
|
|
GetStringMap(path string) (map[string]string, error)
|
|
GetMap(path string) (map[string]interface{}, error)
|
|
MarshalJSON() ([]byte, error)
|
|
UnmarshalJSON([]byte) error
|
|
GetGvk() gvk.Gvk
|
|
GetKind() string
|
|
GetName() string
|
|
SetName(string)
|
|
GetLabels() map[string]string
|
|
SetLabels(map[string]string)
|
|
GetAnnotations() map[string]string
|
|
SetAnnotations(map[string]string)
|
|
}
|
|
|
|
// KunstructuredFactory makes instances of Kunstructured.
|
|
type KunstructuredFactory interface {
|
|
SliceFromBytes([]byte) ([]Kunstructured, error)
|
|
FromMap(m map[string]interface{}) Kunstructured
|
|
Hasher() KunstructuredHasher
|
|
MakeConfigMap(
|
|
ldr Loader,
|
|
options *types.GeneratorOptions,
|
|
args *types.ConfigMapArgs) (Kunstructured, error)
|
|
MakeSecret(
|
|
ldr Loader,
|
|
options *types.GeneratorOptions,
|
|
args *types.SecretArgs) (Kunstructured, error)
|
|
}
|
|
|
|
// KunstructuredHasher returns a hash of the argument
|
|
// or an error.
|
|
type KunstructuredHasher interface {
|
|
Hash(Kunstructured) (string, error)
|
|
}
|
|
|
|
// See core.v1.SecretTypeOpaque
|
|
const SecretTypeOpaque = "Opaque"
|