Commit 4aabda6e authored by Dmitriy Zaporozhets's avatar Dmitriy Zaporozhets

Merge branch '48098-mutual-auth-cluster-applications' into 'master'

Resolve "Mutual SSL Auth For Helm TIller"

Closes #48098

See merge request gitlab-org/gitlab-ce!20928
parents b3deca7a fc134096
# frozen_string_literal: true # frozen_string_literal: true
require 'openssl'
module Clusters module Clusters
module Applications module Applications
class Helm < ActiveRecord::Base class Helm < ActiveRecord::Base
self.table_name = 'clusters_applications_helm' self.table_name = 'clusters_applications_helm'
attr_encrypted :ca_key,
mode: :per_attribute_iv,
key: Settings.attr_encrypted_db_key_base_truncated,
algorithm: 'aes-256-cbc'
include ::Clusters::Concerns::ApplicationCore include ::Clusters::Concerns::ApplicationCore
include ::Clusters::Concerns::ApplicationStatus include ::Clusters::Concerns::ApplicationStatus
default_value_for :version, Gitlab::Kubernetes::Helm::HELM_VERSION default_value_for :version, Gitlab::Kubernetes::Helm::HELM_VERSION
before_create :create_keys_and_certs
def issue_client_cert
ca_cert_obj.issue
end
def set_initial_status def set_initial_status
return unless not_installable? return unless not_installable?
...@@ -17,7 +30,41 @@ module Clusters ...@@ -17,7 +30,41 @@ module Clusters
end end
def install_command def install_command
Gitlab::Kubernetes::Helm::InitCommand.new(name) Gitlab::Kubernetes::Helm::InitCommand.new(
name: name,
files: files
)
end
def has_ssl?
ca_key.present? && ca_cert.present?
end
private
def files
{
'ca.pem': ca_cert,
'cert.pem': tiller_cert.cert_string,
'key.pem': tiller_cert.key_string
}
end
def create_keys_and_certs
ca_cert = Gitlab::Kubernetes::Helm::Certificate.generate_root
self.ca_key = ca_cert.key_string
self.ca_cert = ca_cert.cert_string
end
def tiller_cert
@tiller_cert ||= ca_cert_obj.issue(expires_in: Gitlab::Kubernetes::Helm::Certificate::INFINITE_EXPIRY)
end
def ca_cert_obj
return unless has_ssl?
Gitlab::Kubernetes::Helm::Certificate
.from_strings(ca_key, ca_cert)
end end
end end
end end
......
...@@ -37,10 +37,10 @@ module Clusters ...@@ -37,10 +37,10 @@ module Clusters
def install_command def install_command
Gitlab::Kubernetes::Helm::InstallCommand.new( Gitlab::Kubernetes::Helm::InstallCommand.new(
name, name: name,
version: VERSION, version: VERSION,
chart: chart, chart: chart,
values: values files: files
) )
end end
......
...@@ -38,10 +38,10 @@ module Clusters ...@@ -38,10 +38,10 @@ module Clusters
def install_command def install_command
Gitlab::Kubernetes::Helm::InstallCommand.new( Gitlab::Kubernetes::Helm::InstallCommand.new(
name, name: name,
version: VERSION, version: VERSION,
chart: chart, chart: chart,
values: values, files: files,
repository: repository repository: repository
) )
end end
......
...@@ -46,10 +46,10 @@ module Clusters ...@@ -46,10 +46,10 @@ module Clusters
def install_command def install_command
Gitlab::Kubernetes::Helm::InstallCommand.new( Gitlab::Kubernetes::Helm::InstallCommand.new(
name, name: name,
version: VERSION, version: VERSION,
chart: chart, chart: chart,
values: values files: files
) )
end end
......
...@@ -31,10 +31,10 @@ module Clusters ...@@ -31,10 +31,10 @@ module Clusters
def install_command def install_command
Gitlab::Kubernetes::Helm::InstallCommand.new( Gitlab::Kubernetes::Helm::InstallCommand.new(
name, name: name,
version: VERSION, version: VERSION,
chart: chart, chart: chart,
values: values, files: files,
repository: repository repository: repository
) )
end end
......
...@@ -14,8 +14,34 @@ module Clusters ...@@ -14,8 +14,34 @@ module Clusters
File.read(chart_values_file) File.read(chart_values_file)
end end
def files
@files ||= begin
files = { 'values.yaml': values }
files.merge!(certificate_files) if cluster.application_helm.has_ssl?
files
end
end
private private
def certificate_files
{
'ca.pem': ca_cert,
'cert.pem': helm_cert.cert_string,
'key.pem': helm_cert.key_string
}
end
def ca_cert
cluster.application_helm.ca_cert
end
def helm_cert
@helm_cert ||= cluster.application_helm.issue_client_cert
end
def chart_values_file def chart_values_file
"#{Rails.root}/vendor/#{name}/values.yaml" "#{Rails.root}/vendor/#{name}/values.yaml"
end end
......
---
title: Ensure installed Helm Tiller For GitLab Managed Apps Is protected by mutual
auth
merge_request: 20928
author:
type: changed
# frozen_string_literal: true
class AddColumnsForHelmTillerCertificates < ActiveRecord::Migration
include Gitlab::Database::MigrationHelpers
DOWNTIME = false
def change
add_column :clusters_applications_helm, :encrypted_ca_key, :text
add_column :clusters_applications_helm, :encrypted_ca_key_iv, :text
add_column :clusters_applications_helm, :ca_cert, :text
end
end
...@@ -637,6 +637,9 @@ ActiveRecord::Schema.define(version: 20180726172057) do ...@@ -637,6 +637,9 @@ ActiveRecord::Schema.define(version: 20180726172057) do
t.integer "status", null: false t.integer "status", null: false
t.string "version", null: false t.string "version", null: false
t.text "status_reason" t.text "status_reason"
t.text "encrypted_ca_key"
t.text "encrypted_ca_key_iv"
t.text "ca_cert"
end end
create_table "clusters_applications_ingress", force: :cascade do |t| create_table "clusters_applications_ingress", force: :cascade do |t|
......
module Gitlab module Gitlab
module Kubernetes module Kubernetes
class ConfigMap class ConfigMap
def initialize(name, values = "") def initialize(name, files)
@name = name @name = name
@values = values @files = files
end end
def generate def generate
resource = ::Kubeclient::Resource.new resource = ::Kubeclient::Resource.new
resource.metadata = metadata resource.metadata = metadata
resource.data = { values: values } resource.data = files
resource resource
end end
...@@ -19,7 +19,7 @@ module Gitlab ...@@ -19,7 +19,7 @@ module Gitlab
private private
attr_reader :name, :values attr_reader :name, :files
def metadata def metadata
{ {
......
...@@ -9,7 +9,7 @@ module Gitlab ...@@ -9,7 +9,7 @@ module Gitlab
def install(command) def install(command)
namespace.ensure_exists! namespace.ensure_exists!
create_config_map(command) if command.config_map? create_config_map(command)
kubeclient.create_pod(command.pod_resource) kubeclient.create_pod(command.pod_resource)
end end
......
module Gitlab module Gitlab
module Kubernetes module Kubernetes
module Helm module Helm
class BaseCommand module BaseCommand
attr_reader :name
def initialize(name)
@name = name
end
def pod_resource def pod_resource
Gitlab::Kubernetes::Helm::Pod.new(self, namespace).generate Gitlab::Kubernetes::Helm::Pod.new(self, namespace).generate
end end
...@@ -24,16 +18,32 @@ module Gitlab ...@@ -24,16 +18,32 @@ module Gitlab
HEREDOC HEREDOC
end end
def config_map?
false
end
def pod_name def pod_name
"install-#{name}" "install-#{name}"
end end
def config_map_resource
Gitlab::Kubernetes::ConfigMap.new(name, files).generate
end
def file_names
files.keys
end
def name
raise "Not implemented"
end
def files
raise "Not implemented"
end
private private
def files_dir
"/data/helm/#{name}/config"
end
def namespace def namespace
Gitlab::Kubernetes::Helm::NAMESPACE Gitlab::Kubernetes::Helm::NAMESPACE
end end
......
# frozen_string_literal: true
module Gitlab
module Kubernetes
module Helm
class Certificate
INFINITE_EXPIRY = 1000.years
SHORT_EXPIRY = 30.minutes
attr_reader :key, :cert
def key_string
@key.to_s
end
def cert_string
@cert.to_pem
end
def self.from_strings(key_string, cert_string)
key = OpenSSL::PKey::RSA.new(key_string)
cert = OpenSSL::X509::Certificate.new(cert_string)
new(key, cert)
end
def self.generate_root
_issue(signed_by: nil, expires_in: INFINITE_EXPIRY, certificate_authority: true)
end
def issue(expires_in: SHORT_EXPIRY)
self.class._issue(signed_by: self, expires_in: expires_in, certificate_authority: false)
end
private
def self._issue(signed_by:, expires_in:, certificate_authority:)
key = OpenSSL::PKey::RSA.new(4096)
public_key = key.public_key
subject = OpenSSL::X509::Name.parse("/C=US")
cert = OpenSSL::X509::Certificate.new
cert.subject = subject
cert.issuer = signed_by&.cert&.subject || subject
cert.not_before = Time.now
cert.not_after = expires_in.from_now
cert.public_key = public_key
cert.serial = 0x0
cert.version = 2
if certificate_authority
extension_factory = OpenSSL::X509::ExtensionFactory.new
extension_factory.subject_certificate = cert
extension_factory.issuer_certificate = cert
cert.add_extension(extension_factory.create_extension('subjectKeyIdentifier', 'hash'))
cert.add_extension(extension_factory.create_extension('basicConstraints', 'CA:TRUE', true))
cert.add_extension(extension_factory.create_extension('keyUsage', 'cRLSign,keyCertSign', true))
end
cert.sign(signed_by&.key || key, OpenSSL::Digest::SHA256.new)
new(key, cert)
end
def initialize(key, cert)
@key = key
@cert = cert
end
end
end
end
end
module Gitlab module Gitlab
module Kubernetes module Kubernetes
module Helm module Helm
class InitCommand < BaseCommand class InitCommand
include BaseCommand
attr_reader :name, :files
def initialize(name:, files:)
@name = name
@files = files
end
def generate_script def generate_script
super + [ super + [
init_helm_command init_helm_command
...@@ -11,7 +20,12 @@ module Gitlab ...@@ -11,7 +20,12 @@ module Gitlab
private private
def init_helm_command def init_helm_command
"helm init >/dev/null" tls_flags = "--tiller-tls" \
" --tiller-tls-verify --tls-ca-cert #{files_dir}/ca.pem" \
" --tiller-tls-cert #{files_dir}/cert.pem" \
" --tiller-tls-key #{files_dir}/key.pem"
"helm init #{tls_flags} >/dev/null"
end end
end end
end end
......
module Gitlab module Gitlab
module Kubernetes module Kubernetes
module Helm module Helm
class InstallCommand < BaseCommand class InstallCommand
attr_reader :name, :chart, :version, :repository, :values include BaseCommand
def initialize(name, chart:, values:, version: nil, repository: nil) attr_reader :name, :files, :chart, :version, :repository
def initialize(name:, chart:, files:, version: nil, repository: nil)
@name = name @name = name
@chart = chart @chart = chart
@version = version @version = version
@values = values @files = files
@repository = repository @repository = repository
end end
...@@ -20,14 +22,6 @@ module Gitlab ...@@ -20,14 +22,6 @@ module Gitlab
].compact.join("\n") ].compact.join("\n")
end end
def config_map?
true
end
def config_map_resource
Gitlab::Kubernetes::ConfigMap.new(name, values).generate
end
private private
def init_command def init_command
...@@ -39,14 +33,25 @@ module Gitlab ...@@ -39,14 +33,25 @@ module Gitlab
end end
def script_command def script_command
<<~HEREDOC init_flags = "--name #{name}#{optional_tls_flags}#{optional_version_flag}" \
helm install #{chart} --name #{name}#{optional_version_flag} --namespace #{Gitlab::Kubernetes::Helm::NAMESPACE} -f /data/helm/#{name}/config/values.yaml >/dev/null " --namespace #{Gitlab::Kubernetes::Helm::NAMESPACE}" \
HEREDOC " -f /data/helm/#{name}/config/values.yaml"
"helm install #{chart} #{init_flags} >/dev/null\n"
end end
def optional_version_flag def optional_version_flag
" --version #{version}" if version " --version #{version}" if version
end end
def optional_tls_flags
return unless files.key?(:'ca.pem')
" --tls" \
" --tls-ca-cert #{files_dir}/ca.pem" \
" --tls-cert #{files_dir}/cert.pem" \
" --tls-key #{files_dir}/key.pem"
end
end end
end end
end end
......
...@@ -10,10 +10,8 @@ module Gitlab ...@@ -10,10 +10,8 @@ module Gitlab
def generate def generate
spec = { containers: [container_specification], restartPolicy: 'Never' } spec = { containers: [container_specification], restartPolicy: 'Never' }
if command.config_map?
spec[:volumes] = volumes_specification spec[:volumes] = volumes_specification
spec[:containers][0][:volumeMounts] = volume_mounts_specification spec[:containers][0][:volumeMounts] = volume_mounts_specification
end
::Kubeclient::Resource.new(metadata: metadata, spec: spec) ::Kubeclient::Resource.new(metadata: metadata, spec: spec)
end end
...@@ -61,7 +59,7 @@ module Gitlab ...@@ -61,7 +59,7 @@ module Gitlab
name: 'configuration-volume', name: 'configuration-volume',
configMap: { configMap: {
name: "values-content-configuration-#{command.name}", name: "values-content-configuration-#{command.name}",
items: [{ key: 'values', path: 'values.yaml' }] items: command.file_names.map { |name| { key: name, path: name } }
} }
} }
] ]
......
...@@ -44,10 +44,11 @@ module QA ...@@ -44,10 +44,11 @@ module QA
page.await_installed(:helm) page.await_installed(:helm)
page.install!(:ingress) if @install_ingress page.install!(:ingress) if @install_ingress
page.await_installed(:ingress) if @install_ingress
page.install!(:prometheus) if @install_prometheus page.install!(:prometheus) if @install_prometheus
page.await_installed(:prometheus) if @install_prometheus
page.install!(:runner) if @install_runner page.install!(:runner) if @install_runner
page.await_installed(:ingress) if @install_ingress
page.await_installed(:prometheus) if @install_prometheus
page.await_installed(:runner) if @install_runner page.await_installed(:runner) if @install_runner
end end
end end
......
...@@ -16,6 +16,7 @@ module QA ...@@ -16,6 +16,7 @@ module QA
def install!(application_name) def install!(application_name)
within(".js-cluster-application-row-#{application_name}") do within(".js-cluster-application-row-#{application_name}") do
page.has_button?('Install', wait: 30)
click_on 'Install' click_on 'Install'
end end
end end
......
...@@ -32,11 +32,21 @@ FactoryBot.define do ...@@ -32,11 +32,21 @@ FactoryBot.define do
updated_at ClusterWaitForAppInstallationWorker::TIMEOUT.ago updated_at ClusterWaitForAppInstallationWorker::TIMEOUT.ago
end end
factory :clusters_applications_ingress, class: Clusters::Applications::Ingress factory :clusters_applications_ingress, class: Clusters::Applications::Ingress do
factory :clusters_applications_prometheus, class: Clusters::Applications::Prometheus cluster factory: %i(cluster with_installed_helm provided_by_gcp)
factory :clusters_applications_runner, class: Clusters::Applications::Runner end
factory :clusters_applications_prometheus, class: Clusters::Applications::Prometheus do
cluster factory: %i(cluster with_installed_helm provided_by_gcp)
end
factory :clusters_applications_runner, class: Clusters::Applications::Runner do
cluster factory: %i(cluster with_installed_helm provided_by_gcp)
end
factory :clusters_applications_jupyter, class: Clusters::Applications::Jupyter do factory :clusters_applications_jupyter, class: Clusters::Applications::Jupyter do
oauth_application factory: :oauth_application oauth_application factory: :oauth_application
cluster factory: %i(cluster with_installed_helm provided_by_gcp)
end end
end end
end end
...@@ -36,5 +36,9 @@ FactoryBot.define do ...@@ -36,5 +36,9 @@ FactoryBot.define do
trait :production_environment do trait :production_environment do
sequence(:environment_scope) { |n| "production#{n}/*" } sequence(:environment_scope) { |n| "production#{n}/*" }
end end
trait :with_installed_helm do
application_helm factory: %i(clusters_applications_helm installed)
end
end end
end end
...@@ -46,12 +46,14 @@ describe 'Clusters Applications', :js do ...@@ -46,12 +46,14 @@ describe 'Clusters Applications', :js do
end end
end end
it 'he sees status transition' do it 'they see status transition' do
page.within('.js-cluster-application-row-helm') do page.within('.js-cluster-application-row-helm') do
# FE sends request and gets the response, then the buttons is "Install" # FE sends request and gets the response, then the buttons is "Install"
expect(page.find(:css, '.js-cluster-application-install-button')['disabled']).to eq('true') expect(page.find(:css, '.js-cluster-application-install-button')['disabled']).to eq('true')
expect(page).to have_css('.js-cluster-application-install-button', exact_text: 'Install') expect(page).to have_css('.js-cluster-application-install-button', exact_text: 'Install')
wait_until_helm_created!
Clusters::Cluster.last.application_helm.make_installing! Clusters::Cluster.last.application_helm.make_installing!
# FE starts polling and update the buttons to "Installing" # FE starts polling and update the buttons to "Installing"
...@@ -83,7 +85,7 @@ describe 'Clusters Applications', :js do ...@@ -83,7 +85,7 @@ describe 'Clusters Applications', :js do
end end
end end
it 'he sees status transition' do it 'they see status transition' do
page.within('.js-cluster-application-row-ingress') do page.within('.js-cluster-application-row-ingress') do
# FE sends request and gets the response, then the buttons is "Install" # FE sends request and gets the response, then the buttons is "Install"
expect(page).to have_css('.js-cluster-application-install-button[disabled]') expect(page).to have_css('.js-cluster-application-install-button[disabled]')
...@@ -116,4 +118,14 @@ describe 'Clusters Applications', :js do ...@@ -116,4 +118,14 @@ describe 'Clusters Applications', :js do
end end
end end
end end
def wait_until_helm_created!
retries = 0
while Clusters::Cluster.last.application_helm.nil?
raise "Timed out waiting for helm application to be created in DB" if (retries += 1) > 3
sleep(1)
end
end
end end
...@@ -3,7 +3,7 @@ require 'spec_helper' ...@@ -3,7 +3,7 @@ require 'spec_helper'
describe Gitlab::Kubernetes::ConfigMap do describe Gitlab::Kubernetes::ConfigMap do
let(:kubeclient) { double('kubernetes client') } let(:kubeclient) { double('kubernetes client') }
let(:application) { create(:clusters_applications_prometheus) } let(:application) { create(:clusters_applications_prometheus) }
let(:config_map) { described_class.new(application.name, application.values) } let(:config_map) { described_class.new(application.name, application.files) }
let(:namespace) { Gitlab::Kubernetes::Helm::NAMESPACE } let(:namespace) { Gitlab::Kubernetes::Helm::NAMESPACE }
let(:metadata) do let(:metadata) do
...@@ -15,7 +15,7 @@ describe Gitlab::Kubernetes::ConfigMap do ...@@ -15,7 +15,7 @@ describe Gitlab::Kubernetes::ConfigMap do
end end
describe '#generate' do describe '#generate' do
let(:resource) { ::Kubeclient::Resource.new(metadata: metadata, data: { values: application.values }) } let(:resource) { ::Kubeclient::Resource.new(metadata: metadata, data: application.files) }
subject { config_map.generate } subject { config_map.generate }
it 'should build a Kubeclient Resource' do it 'should build a Kubeclient Resource' do
......
...@@ -39,7 +39,7 @@ describe Gitlab::Kubernetes::Helm::Api do ...@@ -39,7 +39,7 @@ describe Gitlab::Kubernetes::Helm::Api do
end end
context 'with a ConfigMap' do context 'with a ConfigMap' do
let(:resource) { Gitlab::Kubernetes::ConfigMap.new(application.name, application.values).generate } let(:resource) { Gitlab::Kubernetes::ConfigMap.new(application.name, application.files).generate }
it 'creates a ConfigMap on kubeclient' do it 'creates a ConfigMap on kubeclient' do
expect(client).to receive(:create_config_map).with(resource).once expect(client).to receive(:create_config_map).with(resource).once
......
...@@ -2,7 +2,25 @@ require 'spec_helper' ...@@ -2,7 +2,25 @@ require 'spec_helper'
describe Gitlab::Kubernetes::Helm::BaseCommand do describe Gitlab::Kubernetes::Helm::BaseCommand do
let(:application) { create(:clusters_applications_helm) } let(:application) { create(:clusters_applications_helm) }
let(:base_command) { described_class.new(application.name) } let(:test_class) do
Class.new do
include Gitlab::Kubernetes::Helm::BaseCommand
def name
"test-class-name"
end
def files
{
some: 'value'
}
end
end
end
let(:base_command) do
test_class.new
end
subject { base_command } subject { base_command }
...@@ -18,15 +36,9 @@ describe Gitlab::Kubernetes::Helm::BaseCommand do ...@@ -18,15 +36,9 @@ describe Gitlab::Kubernetes::Helm::BaseCommand do
end end
end end
describe '#config_map?' do
subject { base_command.config_map? }
it { is_expected.to be_falsy }
end
describe '#pod_name' do describe '#pod_name' do
subject { base_command.pod_name } subject { base_command.pod_name }
it { is_expected.to eq('install-helm') } it { is_expected.to eq('install-test-class-name') }
end end
end end
# frozen_string_literal: true
require 'spec_helper'
describe Gitlab::Kubernetes::Helm::Certificate do
describe '.generate_root' do
subject { described_class.generate_root }
it 'should generate a root CA that expires a long way in the future' do
expect(subject.cert.not_after).to be > 999.years.from_now
end
end
describe '#issue' do
subject { described_class.generate_root.issue }
it 'should generate a cert that expires soon' do
expect(subject.cert.not_after).to be < 60.minutes.from_now
end
context 'passing in INFINITE_EXPIRY' do
subject { described_class.generate_root.issue(expires_in: described_class::INFINITE_EXPIRY) }
it 'should generate a cert that expires a long way in the future' do
expect(subject.cert.not_after).to be > 999.years.from_now
end
end
end
end
...@@ -2,9 +2,9 @@ require 'spec_helper' ...@@ -2,9 +2,9 @@ require 'spec_helper'
describe Gitlab::Kubernetes::Helm::InitCommand do describe Gitlab::Kubernetes::Helm::InitCommand do
let(:application) { create(:clusters_applications_helm) } let(:application) { create(:clusters_applications_helm) }
let(:commands) { 'helm init >/dev/null' } let(:commands) { 'helm init --tiller-tls --tiller-tls-verify --tls-ca-cert /data/helm/helm/config/ca.pem --tiller-tls-cert /data/helm/helm/config/cert.pem --tiller-tls-key /data/helm/helm/config/key.pem >/dev/null' }
subject { described_class.new(application.name) } subject { described_class.new(name: application.name, files: {}) }
it_behaves_like 'helm commands' it_behaves_like 'helm commands'
end end
require 'rails_helper' require 'rails_helper'
describe Gitlab::Kubernetes::Helm::InstallCommand do describe Gitlab::Kubernetes::Helm::InstallCommand do
let(:application) { create(:clusters_applications_prometheus) } let(:files) { { 'ca.pem': 'some file content' } }
let(:namespace) { Gitlab::Kubernetes::Helm::NAMESPACE } let(:repository) { 'https://repository.example.com' }
let(:install_command) { application.install_command } let(:version) { '1.2.3' }
subject { install_command } let(:install_command) do
described_class.new(
name: 'app-name',
chart: 'chart-name',
files: files,
version: version, repository: repository
)
end
context 'for ingress' do subject { install_command }
let(:application) { create(:clusters_applications_ingress) }
it_behaves_like 'helm commands' do it_behaves_like 'helm commands' do
let(:commands) do let(:commands) do
<<~EOS <<~EOS
helm init --client-only >/dev/null helm init --client-only >/dev/null
helm install #{application.chart} --name #{application.name} --version #{application.version} --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null helm repo add app-name https://repository.example.com
helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
EOS EOS
end end
end end
end
context 'for prometheus' do context 'when there is no repository' do
let(:application) { create(:clusters_applications_prometheus) } let(:repository) { nil }
it_behaves_like 'helm commands' do it_behaves_like 'helm commands' do
let(:commands) do let(:commands) do
<<~EOS <<~EOS
helm init --client-only >/dev/null helm init --client-only >/dev/null
helm install #{application.chart} --name #{application.name} --version #{application.version} --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
EOS EOS
end end
end end
end end
context 'for runner' do context 'when there is no ca.pem file' do
let(:ci_runner) { create(:ci_runner) } let(:files) { { 'file.txt': 'some content' } }
let(:application) { create(:clusters_applications_runner, runner: ci_runner) }
it_behaves_like 'helm commands' do it_behaves_like 'helm commands' do
let(:commands) do let(:commands) do
<<~EOS <<~EOS
helm init --client-only >/dev/null helm init --client-only >/dev/null
helm repo add #{application.name} #{application.repository} helm repo add app-name https://repository.example.com
helm install #{application.chart} --name #{application.name} --version #{application.version} --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null helm install chart-name --name app-name --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
EOS EOS
end end
end end
end end
context 'for jupyter' do context 'when there is no version' do
let(:application) { create(:clusters_applications_jupyter) } let(:version) { nil }
it_behaves_like 'helm commands' do it_behaves_like 'helm commands' do
let(:commands) do let(:commands) do
<<~EOS <<~EOS
helm init --client-only >/dev/null helm init --client-only >/dev/null
helm repo add #{application.name} #{application.repository} helm repo add app-name https://repository.example.com
helm install #{application.chart} --name #{application.name} --version #{application.version} --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
EOS EOS
end end
end end
end end
describe '#config_map?' do
subject { install_command.config_map? }
it { is_expected.to be_truthy }
end
describe '#config_map_resource' do describe '#config_map_resource' do
let(:metadata) do let(:metadata) do
{ {
name: "values-content-configuration-#{application.name}", name: "values-content-configuration-app-name",
namespace: namespace, namespace: 'gitlab-managed-apps',
labels: { name: "values-content-configuration-#{application.name}" } labels: { name: "values-content-configuration-app-name" }
} }
end end
let(:resource) { ::Kubeclient::Resource.new(metadata: metadata, data: { values: application.values }) } let(:resource) { ::Kubeclient::Resource.new(metadata: metadata, data: files) }
subject { install_command.config_map_resource } subject { install_command.config_map_resource }
......
...@@ -2,14 +2,13 @@ require 'rails_helper' ...@@ -2,14 +2,13 @@ require 'rails_helper'
describe Gitlab::Kubernetes::Helm::Pod do describe Gitlab::Kubernetes::Helm::Pod do
describe '#generate' do describe '#generate' do
let(:cluster) { create(:cluster) } let(:app) { create(:clusters_applications_prometheus) }
let(:app) { create(:clusters_applications_prometheus, cluster: cluster) }
let(:command) { app.install_command } let(:command) { app.install_command }
let(:namespace) { Gitlab::Kubernetes::Helm::NAMESPACE } let(:namespace) { Gitlab::Kubernetes::Helm::NAMESPACE }
subject { described_class.new(command, namespace) } subject { described_class.new(command, namespace) }
shared_examples 'helm pod' do context 'with a command' do
it 'should generate a Kubeclient::Resource' do it 'should generate a Kubeclient::Resource' do
expect(subject.generate).to be_a_kind_of(Kubeclient::Resource) expect(subject.generate).to be_a_kind_of(Kubeclient::Resource)
end end
...@@ -41,10 +40,6 @@ describe Gitlab::Kubernetes::Helm::Pod do ...@@ -41,10 +40,6 @@ describe Gitlab::Kubernetes::Helm::Pod do
spec = subject.generate.spec spec = subject.generate.spec
expect(spec.restartPolicy).to eq('Never') expect(spec.restartPolicy).to eq('Never')
end end
end
context 'with a install command' do
it_behaves_like 'helm pod'
it 'should include volumes for the container' do it 'should include volumes for the container' do
container = subject.generate.spec.containers.first container = subject.generate.spec.containers.first
...@@ -60,24 +55,8 @@ describe Gitlab::Kubernetes::Helm::Pod do ...@@ -60,24 +55,8 @@ describe Gitlab::Kubernetes::Helm::Pod do
it 'should mount configMap specification in the volume' do it 'should mount configMap specification in the volume' do
volume = subject.generate.spec.volumes.first volume = subject.generate.spec.volumes.first
expect(volume.configMap['name']).to eq("values-content-configuration-#{app.name}") expect(volume.configMap['name']).to eq("values-content-configuration-#{app.name}")
expect(volume.configMap['items'].first['key']).to eq('values') expect(volume.configMap['items'].first['key']).to eq(:'values.yaml')
expect(volume.configMap['items'].first['path']).to eq('values.yaml') expect(volume.configMap['items'].first['path']).to eq(:'values.yaml')
end
end
context 'with a init command' do
let(:app) { create(:clusters_applications_helm, cluster: cluster) }
it_behaves_like 'helm pod'
it 'should not include volumeMounts inside the container' do
container = subject.generate.spec.containers.first
expect(container.volumeMounts).to be_nil
end
it 'should not a volume inside the specification' do
spec = subject.generate.spec
expect(spec.volumes).to be_nil
end end
end end
end end
......
...@@ -6,13 +6,24 @@ describe Clusters::Applications::Helm do ...@@ -6,13 +6,24 @@ describe Clusters::Applications::Helm do
describe '.installed' do describe '.installed' do
subject { described_class.installed } subject { described_class.installed }
let!(:cluster) { create(:clusters_applications_helm, :installed) } let!(:installed_cluster) { create(:clusters_applications_helm, :installed) }
before do before do
create(:clusters_applications_helm, :errored) create(:clusters_applications_helm, :errored)
end end
it { is_expected.to contain_exactly(cluster) } it { is_expected.to contain_exactly(installed_cluster) }
end
describe '#issue_client_cert' do
let(:application) { create(:clusters_applications_helm) }
subject { application.issue_client_cert }
it 'returns a new cert' do
is_expected.to be_kind_of(Gitlab::Kubernetes::Helm::Certificate)
expect(subject.cert_string).not_to eq(application.ca_cert)
expect(subject.key_string).not_to eq(application.ca_key)
end
end end
describe '#install_command' do describe '#install_command' do
...@@ -25,5 +36,16 @@ describe Clusters::Applications::Helm do ...@@ -25,5 +36,16 @@ describe Clusters::Applications::Helm do
it 'should be initialized with 1 arguments' do it 'should be initialized with 1 arguments' do
expect(subject.name).to eq('helm') expect(subject.name).to eq('helm')
end end
it 'should have cert files' do
expect(subject.files[:'ca.pem']).to be_present
expect(subject.files[:'ca.pem']).to eq(helm.ca_cert)
expect(subject.files[:'cert.pem']).to be_present
expect(subject.files[:'key.pem']).to be_present
cert = OpenSSL::X509::Certificate.new(subject.files[:'cert.pem'])
expect(cert.not_after).to be > 999.years.from_now
end
end end
end end
...@@ -88,7 +88,7 @@ describe Clusters::Applications::Ingress do ...@@ -88,7 +88,7 @@ describe Clusters::Applications::Ingress do
expect(subject.name).to eq('ingress') expect(subject.name).to eq('ingress')
expect(subject.chart).to eq('stable/nginx-ingress') expect(subject.chart).to eq('stable/nginx-ingress')
expect(subject.version).to eq('0.23.0') expect(subject.version).to eq('0.23.0')
expect(subject.values).to eq(ingress.values) expect(subject.files).to eq(ingress.files)
end end
context 'application failed to install previously' do context 'application failed to install previously' do
...@@ -100,14 +100,40 @@ describe Clusters::Applications::Ingress do ...@@ -100,14 +100,40 @@ describe Clusters::Applications::Ingress do
end end
end end
describe '#values' do describe '#files' do
subject { ingress.values } let(:application) { ingress }
let(:values) { subject[:'values.yaml'] }
it 'should include ingress valid keys' do subject { application.files }
is_expected.to include('image')
is_expected.to include('repository') it 'should include ingress valid keys in values' do
is_expected.to include('stats') expect(values).to include('image')
is_expected.to include('podAnnotations') expect(values).to include('repository')
expect(values).to include('stats')
expect(values).to include('podAnnotations')
end
context 'when the helm application does not have a ca_cert' do
before do
application.cluster.application_helm.ca_cert = nil
end
it 'should not include cert files' do
expect(subject[:'ca.pem']).not_to be_present
expect(subject[:'cert.pem']).not_to be_present
expect(subject[:'key.pem']).not_to be_present
end
end
it 'should include cert files' do
expect(subject[:'ca.pem']).to be_present
expect(subject[:'ca.pem']).to eq(application.cluster.application_helm.ca_cert)
expect(subject[:'cert.pem']).to be_present
expect(subject[:'key.pem']).to be_present
cert = OpenSSL::X509::Certificate.new(subject[:'cert.pem'])
expect(cert.not_after).to be < 60.minutes.from_now
end end
end end
end end
...@@ -52,7 +52,7 @@ describe Clusters::Applications::Jupyter do ...@@ -52,7 +52,7 @@ describe Clusters::Applications::Jupyter do
expect(subject.chart).to eq('jupyter/jupyterhub') expect(subject.chart).to eq('jupyter/jupyterhub')
expect(subject.version).to eq('v0.6') expect(subject.version).to eq('v0.6')
expect(subject.repository).to eq('https://jupyterhub.github.io/helm-chart/') expect(subject.repository).to eq('https://jupyterhub.github.io/helm-chart/')
expect(subject.values).to eq(jupyter.values) expect(subject.files).to eq(jupyter.files)
end end
context 'application failed to install previously' do context 'application failed to install previously' do
...@@ -64,19 +64,43 @@ describe Clusters::Applications::Jupyter do ...@@ -64,19 +64,43 @@ describe Clusters::Applications::Jupyter do
end end
end end
describe '#values' do describe '#files' do
let(:jupyter) { create(:clusters_applications_jupyter) } let(:application) { create(:clusters_applications_jupyter) }
let(:values) { subject[:'values.yaml'] }
subject { jupyter.values } subject { application.files }
it 'should include cert files' do
expect(subject[:'ca.pem']).to be_present
expect(subject[:'ca.pem']).to eq(application.cluster.application_helm.ca_cert)
expect(subject[:'cert.pem']).to be_present
expect(subject[:'key.pem']).to be_present
cert = OpenSSL::X509::Certificate.new(subject[:'cert.pem'])
expect(cert.not_after).to be < 60.minutes.from_now
end
context 'when the helm application does not have a ca_cert' do
before do
application.cluster.application_helm.ca_cert = nil
end
it 'should not include cert files' do
expect(subject[:'ca.pem']).not_to be_present
expect(subject[:'cert.pem']).not_to be_present
expect(subject[:'key.pem']).not_to be_present
end
end
it 'should include valid values' do it 'should include valid values' do
is_expected.to include('ingress') expect(values).to include('ingress')
is_expected.to include('hub') expect(values).to include('hub')
is_expected.to include('rbac') expect(values).to include('rbac')
is_expected.to include('proxy') expect(values).to include('proxy')
is_expected.to include('auth') expect(values).to include('auth')
is_expected.to include("clientId: #{jupyter.oauth_application.uid}") expect(values).to match(/clientId: '?#{application.oauth_application.uid}/)
is_expected.to include("callbackUrl: #{jupyter.callback_url}") expect(values).to match(/callbackUrl: '?#{application.callback_url}/)
end end
end end
end end
...@@ -167,7 +167,7 @@ describe Clusters::Applications::Prometheus do ...@@ -167,7 +167,7 @@ describe Clusters::Applications::Prometheus do
expect(command.name).to eq('prometheus') expect(command.name).to eq('prometheus')
expect(command.chart).to eq('stable/prometheus') expect(command.chart).to eq('stable/prometheus')
expect(command.version).to eq('6.7.3') expect(command.version).to eq('6.7.3')
expect(command.values).to eq(prometheus.values) expect(command.files).to eq(prometheus.files)
end end
context 'application failed to install previously' do context 'application failed to install previously' do
...@@ -179,17 +179,41 @@ describe Clusters::Applications::Prometheus do ...@@ -179,17 +179,41 @@ describe Clusters::Applications::Prometheus do
end end
end end
describe '#values' do describe '#files' do
let(:prometheus) { create(:clusters_applications_prometheus) } let(:application) { create(:clusters_applications_prometheus) }
let(:values) { subject[:'values.yaml'] }
subject { application.files }
it 'should include cert files' do
expect(subject[:'ca.pem']).to be_present
expect(subject[:'ca.pem']).to eq(application.cluster.application_helm.ca_cert)
expect(subject[:'cert.pem']).to be_present
expect(subject[:'key.pem']).to be_present
cert = OpenSSL::X509::Certificate.new(subject[:'cert.pem'])
expect(cert.not_after).to be < 60.minutes.from_now
end
subject { prometheus.values } context 'when the helm application does not have a ca_cert' do
before do
application.cluster.application_helm.ca_cert = nil
end
it 'should not include cert files' do
expect(subject[:'ca.pem']).not_to be_present
expect(subject[:'cert.pem']).not_to be_present
expect(subject[:'key.pem']).not_to be_present
end
end
it 'should include prometheus valid values' do it 'should include prometheus valid values' do
is_expected.to include('alertmanager') expect(values).to include('alertmanager')
is_expected.to include('kubeStateMetrics') expect(values).to include('kubeStateMetrics')
is_expected.to include('nodeExporter') expect(values).to include('nodeExporter')
is_expected.to include('pushgateway') expect(values).to include('pushgateway')
is_expected.to include('serverFiles') expect(values).to include('serverFiles')
end end
end end
end end
...@@ -47,7 +47,7 @@ describe Clusters::Applications::Runner do ...@@ -47,7 +47,7 @@ describe Clusters::Applications::Runner do
expect(subject.chart).to eq('runner/gitlab-runner') expect(subject.chart).to eq('runner/gitlab-runner')
expect(subject.version).to eq('0.1.31') expect(subject.version).to eq('0.1.31')
expect(subject.repository).to eq('https://charts.gitlab.io') expect(subject.repository).to eq('https://charts.gitlab.io')
expect(subject.values).to eq(gitlab_runner.values) expect(subject.files).to eq(gitlab_runner.files)
end end
context 'application failed to install previously' do context 'application failed to install previously' do
...@@ -59,27 +59,51 @@ describe Clusters::Applications::Runner do ...@@ -59,27 +59,51 @@ describe Clusters::Applications::Runner do
end end
end end
describe '#values' do describe '#files' do
let(:gitlab_runner) { create(:clusters_applications_runner, runner: ci_runner) } let(:application) { create(:clusters_applications_runner, runner: ci_runner) }
let(:values) { subject[:'values.yaml'] }
subject { application.files }
it 'should include cert files' do
expect(subject[:'ca.pem']).to be_present
expect(subject[:'ca.pem']).to eq(application.cluster.application_helm.ca_cert)
expect(subject[:'cert.pem']).to be_present
expect(subject[:'key.pem']).to be_present
cert = OpenSSL::X509::Certificate.new(subject[:'cert.pem'])
expect(cert.not_after).to be < 60.minutes.from_now
end
subject { gitlab_runner.values } context 'when the helm application does not have a ca_cert' do
before do
application.cluster.application_helm.ca_cert = nil
end
it 'should not include cert files' do
expect(subject[:'ca.pem']).not_to be_present
expect(subject[:'cert.pem']).not_to be_present
expect(subject[:'key.pem']).not_to be_present
end
end
it 'should include runner valid values' do it 'should include runner valid values' do
is_expected.to include('concurrent') expect(values).to include('concurrent')
is_expected.to include('checkInterval') expect(values).to include('checkInterval')
is_expected.to include('rbac') expect(values).to include('rbac')
is_expected.to include('runners') expect(values).to include('runners')
is_expected.to include('privileged: true') expect(values).to include('privileged: true')
is_expected.to include('image: ubuntu:16.04') expect(values).to include('image: ubuntu:16.04')
is_expected.to include('resources') expect(values).to include('resources')
is_expected.to include("runnerToken: #{ci_runner.token}") expect(values).to match(/runnerToken: '?#{ci_runner.token}/)
is_expected.to include("gitlabUrl: #{Gitlab::Routing.url_helpers.root_url}") expect(values).to match(/gitlabUrl: '?#{Gitlab::Routing.url_helpers.root_url}/)
end end
context 'without a runner' do context 'without a runner' do
let(:project) { create(:project) } let(:project) { create(:project) }
let(:cluster) { create(:cluster, projects: [project]) } let(:cluster) { create(:cluster, :with_installed_helm, projects: [project]) }
let(:gitlab_runner) { create(:clusters_applications_runner, cluster: cluster) } let(:application) { create(:clusters_applications_runner, cluster: cluster) }
it 'creates a runner' do it 'creates a runner' do
expect do expect do
...@@ -88,18 +112,18 @@ describe Clusters::Applications::Runner do ...@@ -88,18 +112,18 @@ describe Clusters::Applications::Runner do
end end
it 'uses the new runner token' do it 'uses the new runner token' do
expect(subject).to include("runnerToken: #{gitlab_runner.reload.runner.token}") expect(values).to match(/runnerToken: '?#{application.reload.runner.token}/)
end end
it 'assigns the new runner to runner' do it 'assigns the new runner to runner' do
subject subject
expect(gitlab_runner.reload.runner).to be_project_type expect(application.reload.runner).to be_project_type
end end
end end
context 'with duplicated values on vendor/runner/values.yaml' do context 'with duplicated values on vendor/runner/values.yaml' do
let(:values) do let(:stub_values) do
{ {
"concurrent" => 4, "concurrent" => 4,
"checkInterval" => 3, "checkInterval" => 3,
...@@ -118,11 +142,11 @@ describe Clusters::Applications::Runner do ...@@ -118,11 +142,11 @@ describe Clusters::Applications::Runner do
end end
before do before do
allow(gitlab_runner).to receive(:chart_values).and_return(values) allow(application).to receive(:chart_values).and_return(stub_values)
end end
it 'should overwrite values.yaml' do it 'should overwrite values.yaml' do
is_expected.to include("privileged: #{gitlab_runner.privileged}") expect(values).to match(/privileged: '?#{application.privileged}/)
end end
end end
end end
......
...@@ -47,7 +47,7 @@ describe Clusters::Applications::InstallService do ...@@ -47,7 +47,7 @@ describe Clusters::Applications::InstallService do
end end
context 'when application cannot be persisted' do context 'when application cannot be persisted' do
let(:application) { build(:clusters_applications_helm, :scheduled) } let(:application) { create(:clusters_applications_helm, :scheduled) }
it 'make the application errored' do it 'make the application errored' do
expect(application).to receive(:make_installing!).once.and_raise(ActiveRecord::RecordInvalid) expect(application).to receive(:make_installing!).once.and_raise(ActiveRecord::RecordInvalid)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment