konnectivity

Documentation

Index

• Constants
• type KonnectivityServer
  • func NewServer(so *ServerOptions) (KonnectivityServer, error)
  • func OpDestroy(ks KonnectivityServer) KonnectivityServer
• type Prober
• type ServerOptions
• type ServerSecrets

Constants

const (
	// AgentName is the name of kubernetes resources associated with konnectivity-agent.
	AgentName = "konnectivity-agent"
	// AgentImageName is the name of the konnectivity agent image.
	AgentImageName = AgentName
)

const (
	// ServerName is the name of kubernetes resources associated with konnectivity-server.
	ServerName = "konnectivity-server"
	// SecretNameServerKubeconfig is the name for the konnectivity-server's kubeconfig secret.
	SecretNameServerKubeconfig = "konnectivity-server-kubeconfig"
	// SecretNameServerTLS is the name of the konnectivity-server server certificate secret.
	SecretNameServerTLS = ServerName
	// SecretNameServerCA is the name of the konnectivity-server server certificate authority secret.
	SecretNameServerCA = ServerName + "-ca"
	// ServerCASecretName is the name of the konnectivity-server server certificate authority secret.
	SecretNameServerTLSClient = ServerName + "-client-tls"
	// ServerImageName is the name of the konnectivity-server image.
	ServerImageName = ServerName
	// ServerAudience is the audience of the konnectivity-server used for the token
	ServerAudience = "system:konnectivity-server"
	// ServerHTTPSPort is the port on which konnectivity-server receives traffic from the kube-apiserver.
	ServerHTTPSPort int32 = 9443
	// ServerAgentPort is the port on which konnectivity-server receives traffic from konnectivity-agents.
	ServerAgentPort int32 = 8132
)

Types

type KonnectivityServer

type KonnectivityServer interface {
	component.DeployWaiter
	// SetSecrets sets the konnectivity-server's secrets.
	SetSecrets(ServerSecrets)
}

KonnectivityServer contains functions for a konnectivity-server deployer.

func NewServer

func NewServer(so *ServerOptions) (KonnectivityServer, error)

NewServer creates a new instance of KonnectivityServer for the konnectivity-server.

func OpDestroy

func OpDestroy(ks KonnectivityServer) KonnectivityServer

OpDestroy destroys components created by connectivity server instead of creating them.

type Prober

type Prober func(ctx context.Context, client client.Client, namespace, name string) error

Prober probes specific resource.

type ServerOptions

type ServerOptions struct {
	// Client to create resources with.
	Client client.Client
	// Namespace in the seed cluster.
	Namespace string
	// Image of the konnectivity-server.
	Image string
	// Replica count of the konnectivity-server.
	Replicas int32
	// Hosts used for SNI.
	Hosts []string
	// IstioIngressLabels are the istio-ingressgateway's labels.
	IstioIngressLabels map[string]string
	// Healthy probes that konnectivity-server is healthy.
	// Defaults to managedresources.WaitUntilManagedResourceHealthy.
	Healthy Prober
	// Removed probes that konnectivity-server is removed.
	// Defaults to managedresources.WaitUntilManagedResourceDeleted.
	Removed Prober
}

ServerOptions are the options for the konnectivity-server.

type ServerSecrets

type ServerSecrets struct {
	// Kubeconfig is a secret which can be used by the konnectivity-server to communicate to the kube-apiserver.
	Kubeconfig component.Secret
	// Server is a secret for the HTTPS server.
	Server component.Secret
	// ClientCA is a secret with the CA used by kube-apiserver to authenticate to konnectivity-server.
	ClientCA component.Secret
}

ServerSecrets contains secrets used for the konnectivity-server