https://github.com/vtex/cleaner-controller

https://github.com/vtex/cleaner-controller

developer-experience golang k8s-operator-controller vtex

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vtex/cleaner-controller
• Owner: vtex
• Created: 2022-12-07T15:30:40.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T14:37:37.000Z (9 months ago)
• Last Synced: 2025-01-26T10:08:11.252Z (5 months ago)
• Topics: developer-experience, golang, k8s-operator-controller, vtex
• Language: Go
• Homepage: https://vtex.github.io/cleaner-controller/
• Size: 289 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://drone-robots.vtex.com/api/badges/vtex/cleaner-controller/status.svg?ref=refs/heads/main)](https://drone-robots.vtex.com/vtex/cleaner-controller) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=vtex_cleaner-controller&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vtex_cleaner-controller)

# Cleaner Controller

## Development Cheat Sheet

Introductory reading:

- https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/

- https://book.kubebuilder.io/introduction.html

### CRD Generation

- Edit the [go structs](./api/v1alpha1/conditionalttl_types.go)

- Generate code and manifests:

	```bash

	make generate manifests

	```

- (Optional) Install CRDs

	```bash

	make install

	```

### Reconcile logic

- Edit the [controller code](./controllers/conditionalttl_controller.go)

- Run tests

	```bash

	make test

	```

	- Check code coverage

	```bash

	go tool cover -html=cover.out

	```

- Run controller locally (uses local k8s context authorization)

	```bash

	make run

	```