Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
97aa7961
Commit
97aa7961
authored
Jan 19, 2021
by
Mikhail Mazurskiy
Committed by
Amy Qualls
Jan 19, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add 'Kustomize' to spelling exceptions list
This word should be allowed in our spellcheck.
parent
354081be
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
95 additions
and
0 deletions
+95
-0
doc/.vale/gitlab/spelling-exceptions.txt
doc/.vale/gitlab/spelling-exceptions.txt
+1
-0
doc/development/agent/repository_overview.md
doc/development/agent/repository_overview.md
+94
-0
No files found.
doc/.vale/gitlab/spelling-exceptions.txt
View file @
97aa7961
...
...
@@ -233,6 +233,7 @@ Kubecost
kubectl
Kubernetes
Kubesec
Kustomize
Laravel
ldapsearch
Lefthook
...
...
doc/development/agent/repository_overview.md
0 → 100644
View file @
97aa7961
---
stage
:
Configure
group
:
Configure
info
:
To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
# Kubernetes Agent repository overview **(PREMIUM ONLY)**
This page describes the subfolders of the Kubernetes Agent repository.
[
Development information
](
index.md
)
and
[
end-user documentation
](
../../user/clusters/agent/index.md
)
are both available.
## `build`
Various files for the build process.
### `build/deployment`
A
[
`kpt`
](
https://googlecontainertools.github.io/kpt/
)
package that bundles some
[
Kustomize
](
https://kustomize.io/
)
layers and components. Can be used as-is, or
to create a custom package to install
`agentk`
.
## `cmd`
Commands are binaries that this repository produces. They are:
-
`kas`
is the GitLab Kubernetes Agent Server binary.
-
`agentk`
is the GitLab Kubernetes Agent binary.
Each of these directories contain application bootstrap code for:
-
Reading configuration.
-
Applying defaults to it.
-
Constructing the dependency graph of objects that constitute the program.
-
Running it.
## `examples`
Git submodules for the example projects.
## `internal`
The main code of both
`gitlab-kas`
and
`agentk`
, and various supporting building blocks.
### `internal/agentk`
Main
`agentk`
logic, including the API implementation for agent modules.
### `internal/api`
Structs that represent some important pieces of data.
### `internal/gitaly`
Items to work with
[
Gitaly
](
../../administration/gitaly/index.md
)
.
### `internal/gitlab`
GitLab REST client.
### `internal/kas`
API implementation for the server modules. It contains nothing else, as all server logic
is split into server modules. The bootstrapping glue that wires the modules together
is in
`cmd/kas/kasapp`
.
### `internal/module`
Modules that implement server and agent-side functionality.
### `internal/tool`
Various building blocks.
`internal/tool/testing`
contains mocks and helpers
for testing. Mocks are generated with
[
`gomock`
](
https://pkg.go.dev/github.com/golang/mock
)
.
## `it`
Contains scaffolding for integration tests. Unused at the moment.
## `pkg`
Contains exported packages.
### `pkg/agentcfg`
Contains protobuf definitions of the
`agentk`
configuration file. Used to configure
the agent through a configuration repository.
### `pkg/kascfg`
Contains protobuf definitions of the
`gitlab-kas`
configuration file. Contains an
example of that configuration file along with the test for it. The test ensures
the configuration file example is in sync with the protobuf definitions of the
file and defaults, which are applied when the file is loaded.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment