Documentation
¶
Overview ¶
Package externalsecrets exposes the generated constructors and the admissible sugar for External Secrets Operator resources: ExternalSecret, SecretStore and ClusterSecretStore. Each constructor returns a controller-runtime object carrying identity only; the upstream external-secrets struct is the construction API.
## Constructors
Create<Kind> is generated from the registered scheme and emits apiVersion, kind, metadata.name and, for a namespaced kind, metadata.namespace. Spec fields are the caller's own assignments:
es := externalsecrets.CreateExternalSecret("my-secret", "default")
es.Spec.SecretStoreRef = esv1.SecretStoreRef{Name: "vault", Kind: "ClusterSecretStore"}
externalsecrets.AddExternalSecretData(es, esv1.ExternalSecretData{
SecretKey: "password",
RemoteRef: esv1.ExternalSecretDataRemoteRef{Key: "secret/data/myapp"},
})
## Update helpers
Functions prefixed with Set or Add write exactly the one field they name and fall into the builder contract's admitted classes: AddExternalSecretData and AddDataFrom append, SetSecretStoreProvider, SetClusterSecretStoreProvider and SetRefreshInterval assign a pointer-typed field. Labels and annotations use the generic kubernetes.AddLabel / kubernetes.AddAnnotation over metav1.Object; this package carries no per-kind metadata helpers.
The config-struct layer this package used to carry — ExternalSecret, SecretStore and ClusterSecretStore taking a *Config — was retired by release 2 of the builder contract; see docs/builder-contract-release-2.md for the field-by-field mapping.
Index ¶
- func AddDataFrom(obj *esv1.ExternalSecret, source esv1.ExternalSecretDataFromRemoteRef)
- func AddExternalSecretData(obj *esv1.ExternalSecret, data esv1.ExternalSecretData)
- func CreateClusterExternalSecret(name string) *externalsecretsv1.ClusterExternalSecret
- func CreateClusterSecretStore(name string) *externalsecretsv1.ClusterSecretStore
- func CreateExternalSecret(name, namespace string) *externalsecretsv1.ExternalSecret
- func CreateSecretStore(name, namespace string) *externalsecretsv1.SecretStore
- func SetClusterSecretStoreProvider(obj *esv1.ClusterSecretStore, provider *esv1.SecretStoreProvider)
- func SetRefreshInterval(obj *esv1.ExternalSecret, d metav1.Duration)
- func SetSecretStoreProvider(obj *esv1.SecretStore, provider *esv1.SecretStoreProvider)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddDataFrom ¶
func AddDataFrom(obj *esv1.ExternalSecret, source esv1.ExternalSecretDataFromRemoteRef)
AddDataFrom appends a dataFrom source to an ExternalSecret.
Example ¶
package main
import (
"fmt"
esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
"github.com/go-kure/kure/pkg/kubernetes"
"github.com/go-kure/kure/pkg/kubernetes/externalsecrets"
)
func main() {
es := externalsecrets.CreateExternalSecret("my-secret", "default")
ss := externalsecrets.CreateSecretStore("aws-store", "default")
css := externalsecrets.CreateClusterSecretStore("global-vault")
provider := &esv1.SecretStoreProvider{
AWS: &esv1.AWSProvider{Service: esv1.AWSServiceSecretsManager, Region: "us-east-1"},
}
// Replace the full spec
es.Spec = esv1.ExternalSecretSpec{Target: esv1.ExternalSecretTarget{Name: "my-secret"}}
// Granular updates
externalsecrets.AddExternalSecretData(es, esv1.ExternalSecretData{
SecretKey: "password",
RemoteRef: esv1.ExternalSecretDataRemoteRef{Key: "secret/data/myapp"},
})
externalsecrets.AddDataFrom(es, esv1.ExternalSecretDataFromRemoteRef{
Extract: &esv1.ExternalSecretDataRemoteRef{Key: "secret/data/shared"},
})
es.Spec.SecretStoreRef = esv1.SecretStoreRef{Name: "vault", Kind: "ClusterSecretStore"}
externalsecrets.SetSecretStoreProvider(ss, provider)
ss.Spec.Controller = "my-controller"
externalsecrets.SetClusterSecretStoreProvider(css, provider)
css.Spec.Controller = "global"
// Labels and annotations use the generic helpers, which work over any object
// with ObjectMeta -- this package carries no per-kind metadata helpers
kubernetes.AddLabel(es, "app", "myapp")
kubernetes.AddAnnotation(ss, "desc", "value")
kubernetes.AddLabel(css, "team", "platform")
fmt.Println(len(es.Spec.Data), es.Spec.DataFrom[0].Extract.Key, css.Spec.Controller, es.Labels["app"])
}
Output: 1 secret/data/shared global myapp
func AddExternalSecretData ¶
func AddExternalSecretData(obj *esv1.ExternalSecret, data esv1.ExternalSecretData)
AddExternalSecretData appends a data entry to the ExternalSecret spec.
Example ¶
package main
import (
"fmt"
"time"
esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/go-kure/kure/pkg/kubernetes/externalsecrets"
)
func main() {
es := externalsecrets.CreateExternalSecret("my-secret", "default")
es.Spec.SecretStoreRef = esv1.SecretStoreRef{Name: "vault", Kind: "ClusterSecretStore"}
es.Spec.Target = esv1.ExternalSecretTarget{Name: "my-secret"}
externalsecrets.AddExternalSecretData(es, esv1.ExternalSecretData{
SecretKey: "password",
RemoteRef: esv1.ExternalSecretDataRemoteRef{Key: "secret/data/myapp"},
})
externalsecrets.SetRefreshInterval(es, metav1.Duration{Duration: time.Hour})
fmt.Println(es.Spec.Data[0].SecretKey, es.Spec.RefreshInterval.Duration)
}
Output: password 1h0m0s
func CreateClusterExternalSecret ¶
func CreateClusterExternalSecret(name string) *externalsecretsv1.ClusterExternalSecret
CreateClusterExternalSecret returns a cluster-scoped external-secrets.io/v1 ClusterExternalSecret carrying TypeMeta and identity only.
func CreateClusterSecretStore ¶
func CreateClusterSecretStore(name string) *externalsecretsv1.ClusterSecretStore
CreateClusterSecretStore returns a cluster-scoped external-secrets.io/v1 ClusterSecretStore carrying TypeMeta and identity only.
func CreateExternalSecret ¶
func CreateExternalSecret(name, namespace string) *externalsecretsv1.ExternalSecret
CreateExternalSecret returns a external-secrets.io/v1 ExternalSecret carrying TypeMeta and identity only.
Example ¶
package main
import (
"fmt"
"github.com/go-kure/kure/pkg/kubernetes/externalsecrets"
)
func main() {
obj := externalsecrets.CreateExternalSecret("my-secret", "default")
cl := externalsecrets.CreateClusterSecretStore("global-vault")
fmt.Println(obj.Kind, obj.Namespace+"/"+obj.Name, cl.Kind, cl.Name)
}
Output: ExternalSecret default/my-secret ClusterSecretStore global-vault
func CreateSecretStore ¶
func CreateSecretStore(name, namespace string) *externalsecretsv1.SecretStore
CreateSecretStore returns a external-secrets.io/v1 SecretStore carrying TypeMeta and identity only.
func SetClusterSecretStoreProvider ¶
func SetClusterSecretStoreProvider(obj *esv1.ClusterSecretStore, provider *esv1.SecretStoreProvider)
SetClusterSecretStoreProvider sets the provider field on the ClusterSecretStore spec.
Example ¶
package main
import (
"fmt"
esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
"github.com/go-kure/kure/pkg/kubernetes/externalsecrets"
)
func main() {
css := externalsecrets.CreateClusterSecretStore("global-vault")
externalsecrets.SetClusterSecretStoreProvider(css, &esv1.SecretStoreProvider{
AWS: &esv1.AWSProvider{Service: esv1.AWSServiceSecretsManager, Region: "us-east-1"},
})
fmt.Println(css.Spec.Provider.AWS.Region)
}
Output: us-east-1
func SetRefreshInterval ¶
func SetRefreshInterval(obj *esv1.ExternalSecret, d metav1.Duration)
SetRefreshInterval sets the polling interval on an ExternalSecret.
func SetSecretStoreProvider ¶
func SetSecretStoreProvider(obj *esv1.SecretStore, provider *esv1.SecretStoreProvider)
SetSecretStoreProvider sets the provider field on the SecretStore spec.
Example ¶
package main
import (
"fmt"
esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
"github.com/go-kure/kure/pkg/kubernetes/externalsecrets"
)
func main() {
ss := externalsecrets.CreateSecretStore("aws-store", "default")
externalsecrets.SetSecretStoreProvider(ss, &esv1.SecretStoreProvider{
AWS: &esv1.AWSProvider{Service: esv1.AWSServiceSecretsManager, Region: "us-east-1"},
})
ss.Spec.Controller = "my-controller"
fmt.Println(ss.Spec.Provider.AWS.Region, ss.Spec.Controller)
}
Output: us-east-1 my-controller
Types ¶
This section is empty.