kubernetes

Documentation

Index

• func DefaultConfigFile() string
• func DefaultNamespace() string
• func GetTargetImage(containers map[string]*Container) (string, error)
• func GetTargetRepository(deployments []*Deployment, containers map[string]*Container) (string, error)
• type Client
  • func NewClient(annotationPrefix string, kubeconfig, context string) (*Client, error)
  • func NewClientInCluster(annotationPrefix string) (*Client, error)
  • func (c *Client) CurrentContext() (string, error)
  • func (c *Client) DetectTargetContainer(deployment *Deployment, name string) (*Container, error)
  • func (c *Client) DetectTargetDeployment(namespace, name string) (*Deployment, error)
  • func (c *Client) GetDeployment(namespace, name string) (*Deployment, error)
  • func (c *Client) ListDeployments(namespace string) ([]*Deployment, error)
  • func (c *Client) ListReplicaSets(deployment *Deployment) ([]*ReplicaSet, error)
  • func (c *Client) ReloadPods(deployment *Deployment, user, signature string) (*Deployment, error)
  • func (c *Client) SetImage(deployment *Deployment, container, image, user, cause string) (*Deployment, error)
• type Container
  • func NewContainer(raw *v1.Container) *Container
  • func (c *Container) Image() string
  • func (c *Container) Name() string
• type Deployment
  • func NewDeployment(annotationPrefix string, raw *v1beta1.Deployment) *Deployment
  • func (d *Deployment) Annotations() map[string]string
  • func (d *Deployment) ContainerImage(container string) string
  • func (d *Deployment) Containers() []*Container
  • func (d *Deployment) DeployTargetContainer() (*Container, error)
  • func (d *Deployment) IsDeployTarget() bool
  • func (d *Deployment) Labels() map[string]string
  • func (d *Deployment) Name() string
  • func (d *Deployment) Namespace() string
  • func (d *Deployment) Repositories() (map[string]string, error)
  • func (d *Deployment) UID() string
• type ReplicaSet
  • func NewReplicaSet(annotationPrefix string, raw *v1beta1.ReplicaSet) *ReplicaSet
  • func (r *ReplicaSet) CreatedAt() time.Time
  • func (r *ReplicaSet) DeployUser() string
  • func (r *ReplicaSet) Images() map[string]string
  • func (r *ReplicaSet) Name() string
  • func (r *ReplicaSet) Namespace() string
  • func (r *ReplicaSet) Revision() string

Functions

func DefaultConfigFile

func DefaultConfigFile() string

DefaultConfigFile returns the default kubeconfig file path

func DefaultNamespace

func DefaultNamespace() string

DefaultNamespace returns the default namespace

func GetTargetImage

func GetTargetImage(containers map[string]*Container) (string, error)

GetTargetImage returns the unique image name of target containers

func GetTargetRepository

func GetTargetRepository(deployments []*Deployment, containers map[string]*Container) (string, error)

GetTargetRepository returns the unique GitHub repository of target containers

Types

type Client

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

Client represents the wrapper of Kubernetes API client

func NewClient

func NewClient(annotationPrefix string, kubeconfig, context string) (*Client, error)

NewClient creates Client object using local kubecfg

func NewClientInCluster

func NewClientInCluster(annotationPrefix string) (*Client, error)

NewClientInCluster creates Client object in Kubernetes cluster

func (*Client) CurrentContext

func (c *Client) CurrentContext() (string, error)

CurrentContext returns the current cluster name

func (*Client) DetectTargetContainer

func (c *Client) DetectTargetContainer(deployment *Deployment, name string) (*Container, error)

DetectTargetContainer returns the matched or the first container

func (*Client) DetectTargetDeployment

func (c *Client) DetectTargetDeployment(namespace, name string) (*Deployment, error)

DetectTargetDeployment returns the matched or the first deployment

func (*Client) GetDeployment

func (c *Client) GetDeployment(namespace, name string) (*Deployment, error)

GetDeployment returns a deployment

func (*Client) ListDeployments

func (c *Client) ListDeployments(namespace string) ([]*Deployment, error)

ListDeployments returns the list of deployment

func (*Client) ListReplicaSets

func (c *Client) ListReplicaSets(deployment *Deployment) ([]*ReplicaSet, error)

ListReplicaSets returns the list of ReplicaSets

func (*Client) ReloadPods

func (c *Client) ReloadPods(deployment *Deployment, user, signature string) (*Deployment, error)

ReloadPods reloads all Pods in the given deployment by setting new annotation

func (*Client) SetImage

func (c *Client) SetImage(deployment *Deployment, container, image, user, cause string) (*Deployment, error)

SetImage sets new image to the given deployments

type Container

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

Container represents the wrapper of Kubernetes Pod container

func NewContainer

func NewContainer(raw *v1.Container) *Container

NewContainer creates new Container object

func (*Container) Image

func (c *Container) Image() string

Name represents the image name of container

func (*Container) Name

func (c *Container) Name() string

Name represents the name of contaienr

type Deployment

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

Deployment represents the wrapper of Kubernetes Deployment

func NewDeployment

func NewDeployment(annotationPrefix string, raw *v1beta1.Deployment) *Deployment

NewDeployment creates new Deployment object

func (*Deployment) Annotations

func (d *Deployment) Annotations() map[string]string

Annotations returns the annotations of Deployment

func (*Deployment) ContainerImage

func (d *Deployment) ContainerImage(container string) string

ContainerImage returns image name of the given container

func (*Deployment) Containers

func (d *Deployment) Containers() []*Container

Containers returns the containers inside Deployment

func (*Deployment) DeployTargetContainer

func (d *Deployment) DeployTargetContainer() (*Container, error)

DeployTargetContainer returns - specified in `deploy-target-container` annotation

func (*Deployment) IsDeployTarget

func (d *Deployment) IsDeployTarget() bool

IsDeployTarget returns whether this deployment is deploy target or not - has `deploy-target: 1` or `deploy-target: true` annotation

func (*Deployment) Labels

func (d *Deployment) Labels() map[string]string

Labels returns the labels of Deployment

func (*Deployment) Name

func (d *Deployment) Name() string

Name returns the name of Deployment

func (*Deployment) Namespace

func (d *Deployment) Namespace() string

Namespace returns the namespace of Deployment

func (*Deployment) Repositories

func (d *Deployment) Repositories() (map[string]string, error)

Repositories returns the reportories attached by 'github' annotation

func (*Deployment) UID

func (d *Deployment) UID() string

UID returns the UID of Deployment

type ReplicaSet

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

ReplicaSet represents the wrapper of Kubernetes ReplicaSet

func NewReplicaSet

func NewReplicaSet(annotationPrefix string, raw *v1beta1.ReplicaSet) *ReplicaSet

NewReplicaSet creates ne ReplicaSet object

func (*ReplicaSet) CreatedAt

func (r *ReplicaSet) CreatedAt() time.Time

CreatedAt returns the creation timestamp

func (*ReplicaSet) DeployUser

func (r *ReplicaSet) DeployUser() string

DeployUser returns the deploy user

func (*ReplicaSet) Images

func (r *ReplicaSet) Images() map[string]string

Images returns the list of deployed images at the moment

func (*ReplicaSet) Name

func (r *ReplicaSet) Name() string

Name returns the name of ReplicaSet

func (*ReplicaSet) Namespace

func (r *ReplicaSet) Namespace() string

Namespace returns the namespace of ReplicaSet

func (*ReplicaSet) Revision

func (r *ReplicaSet) Revision() string

Revision returns the revision signature