# Tag
# Description
This repo hold the documentation for the tagging scheme of Nova's resources.
# Rules
If you want to add a tag, it must respect some rules.
- The tags name must be a valid URI, witch start with
tnova.net/
- The tags name must be written in kebab-case
- The tags must be correctly namespaced :
- The tags must be in the correct project folder (jinko, common, ...)
- tech-related tags go into the
tech
folder - business-related tags go into the
bus
folder - and so on...
- tech-related tags go into the
- The tags must be in the correct project folder (jinko, common, ...)
# Example
A Markdown file is located at common/tech/machine-type.md
, the associated tag will be tnova.net/common/tech/machine-type
.
# Awesome list of tags
- tnova.net/ci-runner/tech/type - It determine the type of runner using this resource.
- tnova.net/common/project - This tag define the project that this resource is used for.
- tnova.net/common/tech/garbage - This tag mark this ressources as `garbage`. It mean that this ressources will **not** be automatically deleted, and therefore need to be manually deleted.
- tnova.net/common/tech/git-ref - It designated the commit of the project that were used to create the resource.
- tnova.net/common/tech/owner - Define the Owner of the tagged resource. This tag is used by [Novaworld IAM Policies](https://git.novadiscovery.net/infra/novaworld/-/blob/master/docs/iam-policies-design.md) to setup authorization on AWS resources.
- tnova.net/jinko/tech/k8s-nodegroup-id - Associated to Nodegroups created via `eksctl` by `jinko-gitops`.
- tnova.net/jinko/tech/k8s-nodegroup-spec-hash - Associated to Nodegroups created via `eksctl` by `jinko-gitops`.
- tnova.net/sidekit/tech/environment - Environment for which the Sidekit instance is deployed, i.e. dev, prod, etc.
- tnova.net/sidekit/tech/name - Unique name for the sidekit instance which should represent a clear and simple identifier for this instance. Typically contains the application/tools name being deployed, project for which it is deployed and/or client, etc.