- Run tests locally
- KAS QA tests
You can run
agentk locally to test the Kubernetes Agent yourself.
cfg.yamlfile from the contents of
config_example.yaml, or this example:
agent: listen: network: tcp address: 127.0.0.1:8150 websocket: false gitops: poll_period: "10s" gitlab: address: http://localhost:3000 authentication_secret_file: /Users/tkuah/code/ee-gdk/gitlab/.gitlab_kas_secret
token.txt. This is the token for the agent you created. This file must not contain a newline character. You can create the file with this command:
echo -n "<TOKEN>" > token.txt
Start the binaries with the following commands:
# Need GitLab to start gdk start # Stop GDK's version of kas gdk stop gitlab-k8s-agent # Start kas bazel run //cmd/kas -- --configuration-file="$(pwd)/cfg.yaml"
In a new terminal window, run this command to start
bazel run //cmd/agentk -- --kas-address=grpc://127.0.0.1:8150 --token-file="$(pwd)/token.txt"
You can also inspect the Makefile for more targets.
To learn more about how the repository is structured, see GitLab Kubernetes Agent repository overview.
You can run all tests, or a subset of tests, locally.
To run all tests: Run the command
To run all test targets in the directory: Run the command
bazel test //internal/module/gitops/server:all.
You can use
*in the command, instead of
all, but it must be quoted to avoid shell expansion:
bazel test '//internal/module/gitops/server:*'.
To run all tests in a directory and its subdirectories: Run the command
bazel test //internal/module/gitops/server/....
To run only a specific test scenario, you need the directory name and the target
name of the test. For example, to run the tests at
BUILD.bazel file that
defines the test’s target name lives at
In the latter, the target name is defined like:
go_test( name = "server_test", size = "small", srcs = [ "module_test.go",
The target name is
server_test and the directory is
Run the test scenario with this command:
bazel test //internal/module/gitops/server:server_test
This section describes how to run KAS tests against different GitLab environments based on the GitLab QA orchestrator.
kas QA tests currently have some limitations. You can run them manually on GDK, but they don’t
run automatically with the nightly jobs against the live environment. See the section below
to learn how to run them against different environments.
Before performing any of these tests, if you have a
k3s instance running, make sure to
stop it manually before running them. Otherwise, the tests might fail with the message
failed to remove k3s cluster.
You might need to specify the correct Agent image version that matches the
kas image version. You can use the
GITLAB_AGENTK_VERSION local environment for this.
- Go to your local
qa/qa/service/cluster_provider/k3s.rband comment out this line and this line. We don’t allow local connections on
stagingas they require an admin user.
- Ensure you don’t have an
EE_LICENSEenvironment variable set as this would force an admin login.
- Go to your GDK root folder and
- Login with your user in staging and create a group to be used as sandbox.
- Create an access token for your user with the
Replace the values given below with your own and run:
GITLAB_SANDBOX_NAME="<THE GROUP ID YOU CREATED ON STEP 2>" \ GITLAB_QA_ACCESS_TOKEN="<THE ACCESS TOKEN YOU CREATED ON STEP 3>" \ GITLAB_USERNAME="<YOUR STAGING USERNAME>" \ GITLAB_PASSWORD="<YOUR STAGING PASSWORD>" \ bundle exec bin/qa Test::Instance::All https://staging.gitlab.com -- --tag quarantine qa/specs/features/ee/api/7_configure/kubernetes/kubernetes_agent_spec.rb
- Go to your
qa/qa/fixtures/kubernetes_agent/agentk-manifest.yaml.erband comment out this line and uncomment this line. GDK’s
grpc, not on
- Go to the GDK’s root folder and
On the contrary to staging, run the QA test in GDK as admin, which is the default choice. To do so, use the default sandbox group and run the command below. Make sure to adjust your credentials if necessary, otherwise, the test might fail:
GITLAB_USERNAME=root \ GITLAB_PASSWORD="5iveL\!fe" \ GITLAB_ADMIN_USERNAME=root \ GITLAB_ADMIN_PASSWORD="5iveL\!fe" \ bundle exec bin/qa Test::Instance::All http://gdk.test:3000 -- --tag quarantine qa/specs/features/ee/api/7_configure/kubernetes/kubernetes_agent_spec.rb