Skip to content

Inject kubectl-compatible config file into the CI job

Tiger Watson requested to merge 324275-agent-config-ci-variable into master

What does this MR do?

Adds a KUBECONFIG predefined CI variable for use with the Kubernetes Agent CI Tunnel.

Instead of building a hash of configuration options (as we do currently for the legacy cluster integration), the config file is generated using small wrapper classes. This may seem like overkill, but it will allow for easier file generation in the future when we must merge Kubernetes contexts from multiple sources (Legacy cluster integration, Project and Group-level indexes).

How to setup and validate locally (strongly suggested)

  1. Create an Agent configuration project
  2. Register an agent for your project
  3. Enable the agent_kubeconfig_ci_variable feature flag (Feature.enable(:agent_kubeconfig_ci_variable))
  4. Run a CI job with the following template:
stages:
  - test

test:
  stage: test
  script:
    - cat "$KUBECONFIG"

You should see a config file similar to the following:

---
apiVersion: v1
kind: Config
clusters:
- name: gitlab
  cluster:
    server: https://kas.example.com/k8s-proxy
users:
- name: agent:137
  user:
    token: ci:137:[MASKED]
contexts:
- name: k8s-agent/agent-config:my-agent
  context:
    cluster: gitlab
    user: agent:137

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • [-] Label as security and @ mention @gitlab-com/gl-security/appsec
  • [-] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • [-] Security reports checked/validated by a reviewer from the AppSec team

Related to #324275 (closed)

Edited by Tiger Watson

Merge request reports