Class: Krane::DeprecatedDeployTask

Inherits:

Object

Object
Krane::DeprecatedDeployTask

show all

Extended by:: StatsD::MeasureMethods

Includes:: TemplateReporting

Defined in:: lib/krane/deprecated_deploy_task.rb

Overview

Ship resources to a namespace

Direct Known Subclasses

DeployTask, KubernetesDeploy::DeployTask

Constant Summary collapse

PROTECTED_NAMESPACES =

%w(
  default
  kube-system
  kube-public
)

Instance Method Summary collapse

#initialize(namespace:, context:, current_sha:, logger: nil, kubectl_instance: nil, bindings: {}, max_watch_seconds: nil, selector: nil, template_paths: [], template_dir: nil, protected_namespaces: nil, render_erb: true, allow_globals: false) ⇒ DeprecatedDeployTask constructor

Initializes the deploy task.
#predeploy_sequence ⇒ Object

Things removed from default prune whitelist at github.com/kubernetes/kubernetes/blob/0dff56b4d88ec7551084bf89028dbeebf569620e/pkg/kubectl/cmd/apply.go#L411: core/v1/Namespace – not namespaced core/v1/PersistentVolume – not namespaced core/v1/Endpoints – managed by services core/v1/PersistentVolumeClaim – would delete data core/v1/ReplicationController – superseded by deployments/replicasets.
#prune_whitelist ⇒ Object
#run(*args) ⇒ Boolean

Runs the task, returning a boolean representing success or failure.
#run!(verify_result: true, allow_protected_ns: false, prune: true) ⇒ nil

Runs the task, raising exceptions in case of issues.
#server_version ⇒ Object

Methods included from StatsD::MeasureMethods

measure_method

Methods included from TemplateReporting

#add_para_from_list, #record_invalid_template, #record_warnings

Constructor Details

#initialize(namespace:, context:, current_sha:, logger: nil, kubectl_instance: nil, bindings: {}, max_watch_seconds: nil, selector: nil, template_paths: [], template_dir: nil, protected_namespaces: nil, render_erb: true, allow_globals: false) ⇒ `DeprecatedDeployTask`

Initializes the deploy task

Parameters:

namespace (String) —

Kubernetes namespace
context (String) —

Kubernetes context
current_sha (String) —

The SHA of the commit
logger (Object) (defaults to: nil) —

Logger object (defaults to an instance of Krane::FormattedLogger)
kubectl_instance (Kubectl) (defaults to: nil) —

Kubectl instance
bindings (Hash) (defaults to: {}) —

Bindings parsed by Krane::BindingsParser
max_watch_seconds (Integer) (defaults to: nil) —

Timeout in seconds
selector (Hash) (defaults to: nil) —

Selector(s) parsed by Krane::LabelSelector
template_paths (Array<String>) (defaults to: []) —

An array of template paths
template_dir (String) (defaults to: nil) —

Path to a directory with templates (deprecated)
protected_namespaces (Array<String>) (defaults to: nil) —

Array of protected Kubernetes namespaces (defaults to Krane::DeployTask::PROTECTED_NAMESPACES)
render_erb (Boolean) (defaults to: true) —

Enable ERB rendering

# File 'lib/krane/deprecated_deploy_task.rb', line 128

def initialize(namespace:, context:, current_sha:, logger: nil, kubectl_instance: nil, bindings: {},
  max_watch_seconds: nil, selector: nil, template_paths: [], template_dir: nil, protected_namespaces: nil,
  render_erb: true, allow_globals: false)
  template_dir = File.expand_path(template_dir) if template_dir
  template_paths = (template_paths.map { |path| File.expand_path(path) } << template_dir).compact

  @logger = logger || Krane::FormattedLogger.build(namespace, context)
  @template_sets = TemplateSets.from_dirs_and_files(paths: template_paths, logger: @logger)
  @task_config = Krane::TaskConfig.new(context, namespace, @logger)
  @bindings = bindings
  @namespace = namespace
  @namespace_tags = []
  @context = context
  @current_sha = current_sha
  @kubectl = kubectl_instance
  @max_watch_seconds = max_watch_seconds
  @selector = selector
  @protected_namespaces = protected_namespaces || PROTECTED_NAMESPACES
  @render_erb = render_erb
  @allow_globals = allow_globals
end

Instance Method Details

#predeploy_sequence ⇒ `Object`

Things removed from default prune whitelist at github.com/kubernetes/kubernetes/blob/0dff56b4d88ec7551084bf89028dbeebf569620e/pkg/kubectl/cmd/apply.go#L411: core/v1/Namespace – not namespaced core/v1/PersistentVolume – not namespaced core/v1/Endpoints – managed by services core/v1/PersistentVolumeClaim – would delete data core/v1/ReplicationController – superseded by deployments/replicasets

# File 'lib/krane/deprecated_deploy_task.rb', line 65

def predeploy_sequence
  before_crs = %w(
    ResourceQuota
    NetworkPolicy
  )
  after_crs = %w(
    ConfigMap
    PersistentVolumeClaim
    ServiceAccount
    Role
    RoleBinding
    Secret
    Pod
  )

  before_crs + cluster_resource_discoverer.crds.select(&:predeployed?).map(&:kind) + after_crs
end

#prune_whitelist ⇒ `Object`

# File 'lib/krane/deprecated_deploy_task.rb', line 83

def prune_whitelist
  wl = %w(
    core/v1/ConfigMap
    core/v1/Pod
    core/v1/Service
    core/v1/ResourceQuota
    core/v1/Secret
    core/v1/ServiceAccount
    core/v1/PodTemplate
    core/v1/PersistentVolumeClaim
    batch/v1/Job
    apps/v1/ReplicaSet
    apps/v1/DaemonSet
    apps/v1/Deployment
    extensions/v1beta1/Ingress
    networking.k8s.io/v1/NetworkPolicy
    apps/v1/StatefulSet
    autoscaling/v1/HorizontalPodAutoscaler
    policy/v1beta1/PodDisruptionBudget
    batch/v1beta1/CronJob
    rbac.authorization.k8s.io/v1/Role
    rbac.authorization.k8s.io/v1/RoleBinding
  )
  wl + cluster_resource_discoverer.crds.select(&:prunable?).map(&:group_version_kind)
end

#run(*args) ⇒ `Boolean`

Runs the task, returning a boolean representing success or failure

Returns:

(Boolean)

# File 'lib/krane/deprecated_deploy_task.rb', line 153

def run(*args)
  run!(*args)
  true
rescue FatalDeploymentError
  false
end

#run!(verify_result: true, allow_protected_ns: false, prune: true) ⇒ `nil`

Runs the task, raising exceptions in case of issues