pkg/kubernetes/internal/interfaces.go

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

package internal

import (
	appsv1 "k8s.io/api/apps/v1"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// Client interface models client for interacting with kubernetes api server
type Client interface {
	// ListPodsByOptions returns Pods based on the passed in list options.
	ListPodsByOptions(namespace string, opts metav1.ListOptions) (*v1.PodList, error)
	// ListNodes returns a list of Nodes registered in the api server.
	ListNodes() (*v1.NodeList, error)
	// ListServiceAccountsByOptions returns a list of Service Accounts in the provided namespace.
	ListServiceAccountsByOptions(namespace string, opts metav1.ListOptions) (*v1.ServiceAccountList, error)
	// ListDeployments returns a list of deployments in the provided namespace.
	ListDeployments(namespace string, opts metav1.ListOptions) (*appsv1.DeploymentList, error)
	// ListDaemonSets returns a list of daemonsets in the provided namespace.
	ListDaemonSets(namespace string, opts metav1.ListOptions) (*appsv1.DaemonSetList, error)
	// ListSecrets returns a list of secrets in the provided namespace.
	ListSecrets(namespace string, opts metav1.ListOptions) (*v1.SecretList, error)
	// PatchDeployment applies a JSON patch to a deployment in the provided namespace.
	PatchDeployment(namespace, name, jsonPatch string) (*appsv1.Deployment, error)
	// PatchDaemonSet applies a JSON patch to a daemonset in the provided namespace.
	PatchDaemonSet(namespace, name, jsonPatch string) (*appsv1.DaemonSet, error)
	// GetDeployment returns a given deployment in a namespace.
	GetDeployment(namespace, name string) (*appsv1.Deployment, error)
	// DeletePods deletes all pods in a namespace that match the option filters.
	DeletePods(namespace string, opts metav1.ListOptions) error
	// DeleteSecret deletes the passed in secret.
	DeleteSecret(secret *v1.Secret) error
	// DeleteServiceAccount deletes the passed in service account.
	DeleteServiceAccount(sa *v1.ServiceAccount) error
}