dyrector.io platform: crane

We are working on the source code documentation, until then please use the root README.md for further information or check our official documentation site.

Implement the current interface for Kubernetes deployments.

Swagger

go get -u github.com/swaggo/swag/cmd/swag

Regenerate swagger files - this is not automatic, please execute on change

swag init --parseDependency --parseInternal --parseVendor

Debug

Needed for debugging:

• https://github.com/go-delve/delve
• Go Tools for VSCode
• Add launch json: Launch package

Debug locally using Remote Instance

1. Install ngrok - https://ngrok.com/
2. Start crane locally
3. Add/Modify your ngrok URL using the dyrector.io UI eg. d41a98d7ba2c.ngrok.io

Linting

https://golangci-lint.run/

Run installed tool with like so

golangci-lint run

Test

Setup k3s

make k3s-start
make k3s-config
# run this to clean up
# make k3s-clean

Being at the repository root, after setting it up execute

make k3s-test

For testing, to debug tests, overriding the KUBECONFIG variable as it is done in the Makefile.

Calculate coverage

./dev/coverage.sh
# the relative route is important

Deployment

The configuration will prioritize Environmental Variables, .env file, and defaults in this order with Environmental variables taking the highest priority.

Configuration will take place before starting up the application, and store the configuration options in a global variable, which can be accessed during runtime. Both Crane and DAgent have their own configuration package to add their own defaults and/or add their own custom variables. When the variables are used to achieve similar functions, can be found in both projects, and have the same defaults; then it can be found in a "common" config package. Please see the common README.md for more.

Environment variable	Description	Default
CRANE_GEN_TCP_INGRESS_MAP	Under obsoletion	none
CRANE_IN_CLUSTER	Put true to use in-cluster auth	true
DEFAULT_KUBE_TIMEOUT	Kube	2m
FIELD_MANAGER_NAME	Field manager name	crane-dyrector-io
FORCE_ON_CONFLICTS	Use Force: true while deploying	true
KEY_ISSUER	The key/label name for audit purposes	co.dyrector.io/issuer
KUBECONFIG	The "kubectl" configuration location	none
TEST_TIMEOUT	Timeouts used in tests, no effect on deployment	15s

In-cluster

uses the current namespace's default service account

Deploy crane into a cluster:

• deploy with yaml files or other crane
• add Admin RoleBinding to namespace (better use RBAC, not sure all roles needed)

Off-cluster

Uses the home folder of the user, it is a kubeconfig file

Steps:

• get a valid kubeconfig file - be able to run kubectl get all
• run

Tools

GRPC

Install grpcurl, see example request.

grpcurl -plaintext localhost:50051 agent.Agent.Deploy

Questions

If you have any questions please ask your teammates and extend the documentation with the missing pieces. Thanks ✌️