client

Documentation

Index

• Constants
• func NewFakeDiscoveryClient(registeredResouces []schema.GroupVersionResource) *fakeDiscoveryClient
• type Client
  • func NewClient(config *rest.Config) (*Client, error)
  • func NewMockClient(scheme *runtime.Scheme, objects ...runtime.Object) (*Client, error)
  • func (c *Client) CreatePolicyViolation(pv kyvernov.ClusterPolicyViolation) error
  • func (c *Client) CreateResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)
  • func (c *Client) DeleteResouce(kind string, namespace string, name string, dryRun bool) error
  • func (c *Client) GenerateResource(generator kyverno.Generation, namespace string, processExistingResources bool) error
  • func (c *Client) GenerateTlsPemPair(props tls.TlsCertificateProps) (*tls.TlsPemPair, error)
  • func (c *Client) GetAppsV1Interface() appsv1.AppsV1Interface
  • func (c *Client) GetCSRInterface() (csrtype.CertificateSigningRequestInterface, error)
  • func (c *Client) GetEventsInterface() (event.EventInterface, error)
  • func (c *Client) GetKubePolicyDeployment() (*apps.Deployment, error)
  • func (c *Client) GetResource(kind string, namespace string, name string, subresources ...string) (*unstructured.Unstructured, error)
  • func (c *Client) GetTLSCertProps(configuration *rest.Config) (certProps tls.TlsCertificateProps, err error)
  • func (c *Client) ListResource(kind string, namespace string, lselector *meta.LabelSelector) (*unstructured.UnstructuredList, error)
  • func (c *Client) PatchResource(kind string, namespace string, name string, patch []byte) (*unstructured.Unstructured, error)
  • func (c *Client) ReadRootCASecret() (result []byte)
  • func (c *Client) ReadTlsPair(props tls.TlsCertificateProps) *tls.TlsPemPair
  • func (c *Client) SetDiscovery(discoveryClient IDiscovery)
  • func (c *Client) UpdateResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)
  • func (c *Client) UpdateStatusResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)
  • func (c *Client) WriteTlsPair(props tls.TlsCertificateProps, pemPair *tls.TlsPemPair) error
• type IDiscovery
• type ServerPreferredResources
  • func (c ServerPreferredResources) GetGVRFromKind(kind string) schema.GroupVersionResource

Constants

const (
	// Kind names are case sensitive
	//CSRs CertificateSigningRequest
	CSRs string = "CertificateSigningRequest"
	// Secrets Secret
	Secrets string = "Secret"
	// ConfigMaps ConfigMap
	ConfigMaps string = "ConfigMap"
	// Namespaces Namespace
	Namespaces string = "Namespace"
)

Functions

func NewFakeDiscoveryClient

func NewFakeDiscoveryClient(registeredResouces []schema.GroupVersionResource) *fakeDiscoveryClient

NewFakeDiscoveryClient returns a fakediscovery client

Types

type Client

type Client struct {
	DiscoveryClient IDiscovery
	// contains filtered or unexported fields
}

Client enables interaction with k8 resource

func NewClient

func NewClient(config *rest.Config) (*Client, error)

NewClient creates new instance of client

func NewMockClient

func NewMockClient(scheme *runtime.Scheme, objects ...runtime.Object) (*Client, error)

---testing utilities

func (*Client) CreatePolicyViolation

func (c *Client) CreatePolicyViolation(pv kyvernov.ClusterPolicyViolation) error

CreatePolicyViolation create a Policy Violation resource

func (*Client) CreateResource

func (c *Client) CreateResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)

CreateResource creates object for the specified resource/namespace

func (*Client) DeleteResouce

func (c *Client) DeleteResouce(kind string, namespace string, name string, dryRun bool) error

DeleteResouce deletes the specified resource

func (*Client) GenerateResource

func (c *Client) GenerateResource(generator kyverno.Generation, namespace string, processExistingResources bool) error

GenerateResource creates resource of the specified kind(supports 'clone' & 'data')

func (*Client) GenerateTlsPemPair

func (c *Client) GenerateTlsPemPair(props tls.TlsCertificateProps) (*tls.TlsPemPair, error)

GenerateTlsPemPair Issues TLS certificate for webhook server using given PEM private key Returns signed and approved TLS certificate in PEM format

func (*Client) GetAppsV1Interface

func (c *Client) GetAppsV1Interface() appsv1.AppsV1Interface

func (*Client) GetCSRInterface

func (c *Client) GetCSRInterface() (csrtype.CertificateSigningRequestInterface, error)

GetCSRInterface provides type interface for CSR

func (*Client) GetEventsInterface

func (c *Client) GetEventsInterface() (event.EventInterface, error)

GetEventsInterface provides typed interface for events TODO: can we use dynamic client to fetch the typed interface or generate a kube client value to access the interface

func (*Client) GetKubePolicyDeployment

func (c *Client) GetKubePolicyDeployment() (*apps.Deployment, error)

GetKubePolicyDeployment returns kube policy depoyment value

func (*Client) GetResource

func (c *Client) GetResource(kind string, namespace string, name string, subresources ...string) (*unstructured.Unstructured, error)

GetResource returns the resource in unstructured/json format

func (*Client) GetTLSCertProps

func (c *Client) GetTLSCertProps(configuration *rest.Config) (certProps tls.TlsCertificateProps, err error)

GetTLSCertProps provides the TLS Certificate Properties

func (*Client) ListResource

func (c *Client) ListResource(kind string, namespace string, lselector *meta.LabelSelector) (*unstructured.UnstructuredList, error)

ListResource returns the list of resources in unstructured/json format Access items using []Items

func (*Client) PatchResource

func (c *Client) PatchResource(kind string, namespace string, name string, patch []byte) (*unstructured.Unstructured, error)

Patch

func (*Client) ReadRootCASecret

func (c *Client) ReadRootCASecret() (result []byte)

ReadRootCASecret returns the RootCA from the pre-defined secret

func (*Client) ReadTlsPair

func (c *Client) ReadTlsPair(props tls.TlsCertificateProps) *tls.TlsPemPair

ReadTlsPair Reads the pair of TLS certificate and key from the specified secret.

func (*Client) SetDiscovery

func (c *Client) SetDiscovery(discoveryClient IDiscovery)

func (*Client) UpdateResource

func (c *Client) UpdateResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)

UpdateResource updates object for the specified resource/namespace

func (*Client) UpdateStatusResource

func (c *Client) UpdateStatusResource(kind string, namespace string, obj interface{}, dryRun bool) (*unstructured.Unstructured, error)

UpdateStatusResource updates the resource "status" subresource

func (*Client) WriteTlsPair

func (c *Client) WriteTlsPair(props tls.TlsCertificateProps, pemPair *tls.TlsPemPair) error

WriteTlsPair Writes the pair of TLS certificate and key to the specified secret. Updates existing secret or creates new one.

type IDiscovery

type IDiscovery interface {
	GetGVRFromKind(kind string) schema.GroupVersionResource
}

type ServerPreferredResources

type ServerPreferredResources struct {
	// contains filtered or unexported fields
}

func (ServerPreferredResources) GetGVRFromKind

func (c ServerPreferredResources) GetGVRFromKind(kind string) schema.GroupVersionResource

GetGVRFromKind get the Group Version Resource from kind if kind is not found in first attempt we invalidate the cache, the retry will then fetch the new registered resources and check again if not found after 2 attempts, we declare kind is not found kind is Case sensitive