kubernetes.rb 5.1 KB
Newer Older
1 2 3
module Clusters
  module Platforms
    class Kubernetes < ActiveRecord::Base
S
Shinya Maeda 已提交
4
      include Gitlab::CurrentSettings
5 6 7
      include Gitlab::Kubernetes
      include ReactiveCaching

S
Shinya Maeda 已提交
8 9
      self.table_name = 'cluster_platforms_kubernetes'
      self.reactive_cache_key = ->(kubernetes) { [kubernetes.class.model_name.singular, kubernetes.cluster_id] }
10

S
Shinya Maeda 已提交
11
      belongs_to :cluster, inverse_of: :platform_kubernetes, class_name: 'Clusters::Cluster'
12 13 14 15 16 17 18 19 20 21 22

      attr_encrypted :password,
        mode: :per_attribute_iv,
        key: Gitlab::Application.secrets.db_key_base,
        algorithm: 'aes-256-cbc'

      attr_encrypted :token,
        mode: :per_attribute_iv,
        key: Gitlab::Application.secrets.db_key_base,
        algorithm: 'aes-256-cbc'

S
Shinya Maeda 已提交
23 24
      before_validation :enforce_namespace_to_lower_case

25 26 27 28 29 30 31 32
      validates :namespace,
        allow_blank: true,
        length: 1..63,
        format: {
          with: Gitlab::Regex.kubernetes_namespace_regex,
          message: Gitlab::Regex.kubernetes_namespace_regex_message
        }

33 34
      validates :api_url, url: true, presence: true
      validates :token, presence: true
35 36

      after_save :clear_reactive_cache!
S
Shinya Maeda 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49

      alias_attribute :ca_pem, :ca_cert

      delegate :project, to: :cluster, allow_nil: true
      delegate :enabled?, to: :cluster, allow_nil: true

      alias_method :active?, :enabled?

      class << self
        def namespace_for_project(project)
          "#{project.path}-#{project.id}"
        end
      end
50 51 52 53 54 55 56 57 58

      def actual_namespace
        if namespace.present?
          namespace
        else
          default_namespace
        end
      end

S
Shinya Maeda 已提交
59 60 61 62
      def default_namespace
        self.class.namespace_for_project(project) if project
      end

63 64 65 66 67 68 69 70 71 72
      def predefined_variables
        config = YAML.dump(kubeconfig)

        variables = [
          { key: 'KUBE_URL', value: api_url, public: true },
          { key: 'KUBE_TOKEN', value: token, public: false },
          { key: 'KUBE_NAMESPACE', value: actual_namespace, public: true },
          { key: 'KUBECONFIG', value: config, public: false, file: true }
        ]

S
Shinya Maeda 已提交
73 74 75
        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 }
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
        end

        variables
      end

      # 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|
          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) }
        end
      end

      # Caches resources in the namespace so other calls don't need to block on
      # network access
      def calculate_reactive_cache
S
Shinya Maeda 已提交
96
        return unless active? && project && !project.pending_delete?
97 98 99 100 101 102 103 104 105 106

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

      def kubeconfig
        to_kubeconfig(
          url: api_url,
          namespace: actual_namespace,
          token: token,
S
Shinya Maeda 已提交
107
          ca_pem: ca_pem)
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
      end

      def read_secrets
        kubeclient = build_kubeclient!

        kubeclient.get_secrets.as_json
      end

      # 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
        []
      end

      def kubeclient_ssl_options
        opts = { verify_ssl: OpenSSL::SSL::VERIFY_PEER }

S
Shinya Maeda 已提交
129
        if ca_pem.present?
130
          opts[:cert_store] = OpenSSL::X509::Store.new
S
Shinya Maeda 已提交
131
          opts[:cert_store].add_cert(OpenSSL::X509::Certificate.new(ca_pem))
132 133 134 135 136 137 138 139
        end

        opts
      end

      private

      def build_kubeclient!(api_path: 'api', api_version: 'v1')
S
Shinya Maeda 已提交
140 141 142 143 144
        raise "Incomplete settings" unless api_url && actual_namespace

        unless (username && password) || token
          raise "Either username/password or token is required to access API"
        end
145 146 147 148 149 150 151 152 153 154 155

        ::Kubeclient::Client.new(
          join_api_url(api_path),
          api_version,
          auth_options: kubeclient_auth_options,
          ssl_options: kubeclient_ssl_options,
          http_proxy_uri: ENV['http_proxy']
        )
      end

      def kubeclient_auth_options
S
Shinya Maeda 已提交
156
        return { username: username, password: password } if username && password
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
        return { bearer_token: token } if token
      end

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

        url.path = [prefix, api_path].join("/")

        url.to_s
      end

      def terminal_auth
        {
          token: token,
S
Shinya Maeda 已提交
172
          ca_pem: ca_pem,
173 174 175 176 177 178 179 180 181 182
          max_session_time: current_application_settings.terminal_max_session_time
        }
      end

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