kubernetes_service.rb 5.47 KB
Newer Older
1
class KubernetesService < DeploymentService
2
  include Gitlab::CurrentSettings
3 4 5
  include Gitlab::Kubernetes
  include ReactiveCaching

6
  self.reactive_cache_key = ->(service) { [service.class.model_name.singular, service.project_id] }
7

8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
  # Namespace defaults to the project path, but can be overridden in case that
  # is an invalid or inappropriate name
  prop_accessor :namespace

  #  Access to kubernetes is directly through the API
  prop_accessor :api_url

  # Bearer authentication
  # TODO:  user/password auth, client certificates
  prop_accessor :token

  # Provide a custom CA bundle for self-signed deployments
  prop_accessor :ca_pem

  with_options presence: true, if: :activated? do
    validates :api_url, url: true
    validates :token
  end

27 28
  before_validation :enforce_namespace_to_lower_case

29 30 31 32 33 34 35 36 37
  validates :namespace,
    allow_blank: true,
    length: 1..63,
    if: :activated?,
    format: {
      with: Gitlab::Regex.kubernetes_namespace_regex,
      message: Gitlab::Regex.kubernetes_namespace_regex_message
    }

38 39
  after_save :clear_reactive_cache!

40
  def initialize_properties
41
    self.properties = {} if properties.nil?
42 43 44 45 46 47 48 49 50 51 52
  end

  def title
    'Kubernetes'
  end

  def description
    'Kubernetes / Openshift integration'
  end

  def help
53 54
    'To enable terminal access to Kubernetes environments, label your ' \
    'deployments with `app=$CI_ENVIRONMENT_SLUG`'
55 56
  end

57
  def self.to_param
58 59 60 61 62 63 64 65
    'kubernetes'
  end

  def fields
    [
        { type: 'text',
          name: 'api_url',
          title: 'API URL',
66
          placeholder: 'Kubernetes API URL, like https://kube.example.com/' },
67 68
        { type: 'textarea',
          name: 'ca_pem',
69 70 71 72 73 74 75 76 77 78
          title: 'CA Certificate',
          placeholder: 'Certificate Authority bundle (PEM format)' },
        { type: 'text',
          name: 'namespace',
          title: 'Project namespace (optional/unique)',
          placeholder: namespace_placeholder },
        { type: 'text',
          name: 'token',
          title: 'Token',
          placeholder: 'Service token' }
79 80 81
    ]
  end

82 83 84 85 86 87 88 89
  def actual_namespace
    if namespace.present?
      namespace
    else
      default_namespace
    end
  end

90 91
  # Check we can connect to the Kubernetes API
  def test(*args)
92
    kubeclient = build_kubeclient!
93

94
    kubeclient.discover
95 96 97 98 99
    { success: kubeclient.discovered, result: "Checked API discovery endpoint" }
  rescue => err
    { success: false, result: err }
  end

100
  def predefined_variables
101 102
    config = YAML.dump(kubeconfig)

103 104 105
    variables = [
      { key: 'KUBE_URL', value: api_url, public: true },
      { key: 'KUBE_TOKEN', value: token, public: false },
106
      { key: 'KUBE_NAMESPACE', value: actual_namespace, public: true },
107
      { key: 'KUBECONFIG', value: config, public: false, file: true }
108
    ]
109 110 111 112 113 114

    if ca_pem.present?
      variables << { key: 'KUBE_CA_PEM', value: ca_pem, public: true }
      variables << { key: 'KUBE_CA_PEM_FILE', value: ca_pem, public: true, file: true }
    end

115 116 117
    variables
  end

118 119 120 121 122 123
  # Constructs a list of terminals from the reactive cache
  #
  # Returns nil if the cache is empty, in which case you should try again a
  # short time later
  def terminals(environment)
    with_reactive_cache do |data|
124 125 126
      pods = filter_by_label(data[:pods], app: environment.slug)
      terminals = pods.flat_map { |pod| terminals_for_pod(api_url, actual_namespace, pod) }
      terminals.each { |terminal| add_terminal_auth(terminal, terminal_auth) }
127 128
    end
  end
129

130 131
  # Caches resources in the namespace so other calls don't need to block on
  # network access
132 133
  def calculate_reactive_cache
    return unless active? && project && !project.pending_delete?
134

135
    # We may want to cache extra things in the future
136
    { pods: read_pods }
137 138
  end

139 140
  def kubeclient
    @kubeclient ||= build_kubeclient!
141 142
  end

143 144
  TEMPLATE_PLACEHOLDER = 'Kubernetes namespace'.freeze

145 146
  private

147 148 149 150 151 152 153 154
  def kubeconfig
    to_kubeconfig(
      url: api_url,
      namespace: actual_namespace,
      token: token,
      ca_pem: ca_pem)
  end

155 156 157 158 159
  def namespace_placeholder
    default_namespace || TEMPLATE_PLACEHOLDER
  end

  def default_namespace
160 161
    return unless project

162 163
    slug = "#{project.path}-#{project.id}".downcase
    slug.gsub(/[^-a-z0-9]/, '-').gsub(/^-+/, '')
164 165
  end

166
  def build_kubeclient!(api_path: 'api', api_version: 'v1')
167
    raise "Incomplete settings" unless api_url && actual_namespace && token
168 169

    ::Kubeclient::Client.new(
170
      join_api_url(api_path),
171 172
      api_version,
      auth_options: kubeclient_auth_options,
173
      ssl_options: kubeclient_ssl_options,
174 175 176 177
      http_proxy_uri: ENV['http_proxy']
    )
  end

178 179 180 181 182 183 184
  # Returns a hash of all pods in the namespace
  def read_pods
    kubeclient = build_kubeclient!

    kubeclient.get_pods(namespace: actual_namespace).as_json
  rescue KubeException => err
    raise err unless err.error_code == 404
185

186 187 188
    []
  end

189 190 191 192 193 194 195 196 197 198 199 200 201 202
  def kubeclient_ssl_options
    opts = { verify_ssl: OpenSSL::SSL::VERIFY_PEER }

    if ca_pem.present?
      opts[:cert_store] = OpenSSL::X509::Store.new
      opts[:cert_store].add_cert(OpenSSL::X509::Certificate.new(ca_pem))
    end

    opts
  end

  def kubeclient_auth_options
    { bearer_token: token }
  end
203

204
  def join_api_url(api_path)
205 206 207
    url = URI.parse(api_url)
    prefix = url.path.sub(%r{/+\z}, '')

208
    url.path = [prefix, api_path].join("/")
209 210 211

    url.to_s
  end
212 213 214 215 216 217 218 219

  def terminal_auth
    {
      token: token,
      ca_pem: ca_pem,
      max_session_time: current_application_settings.terminal_max_session_time
    }
  end
220 221 222 223

  def enforce_namespace_to_lower_case
    self.namespace = self.namespace&.downcase
  end
224
end