This document describes how to manually create, update or delete Logging Custom Resource Definitions (CRDs).
When is it needed?¶
Almost all Qubership applications and microservices are integrated with Logging. This integration means
that almost all microservices during deploy can create LoggingService objects from the API
logging.qubership.org.
Such objects allow for Logging to understand from which microservices and how to collect metrics. Similar objects allow providing alerts, recording rules and Grafana dashboards.
Also, it means that before deploying applications and microservices in Kubernetes all Custom Resource Definitions (CRDs) must already created in Kubernetes. Otherwise, the deployment will fail.
The deployment process (helm chart) of Logging will automatically install or update all required CRDs. But there are environments where Logging can't or doesn't make sense to deploy. In such cases, there is an ability to create or update CRDs manually.
In the list of Logging artifacts, you can find an archive with the name
that contains all CRDs related to AMS operator that are required for Logging. How to use this archive and CRDs inside you can read below.
Before you begin¶
- You should have cluster-wide permissions enough to operate with CRDs (cluster admin is not required)
- You should configure a context for your
kubectland make sure the connection configured to correct Kubernetes
How to manage CRDs¶
This section describes different cases of manual manipulation with CRDs.
Create¶
To create CRDs for Logging you need to execute the command:
Warning! Never use the kubectl apply command! This command will generate the annotation
kubectl.kubernetes.io/last-applied-configuration that will contain the whole content of CRD.
It means that the object size will be increasing two times and it may lead to problems with storing
this CRD in Etcd.
mkdir /tmp/crds/
unzip -d /tmp/crds/ logging-operator-<version>-crds.zip
kubectl create -f /tmp/crds/*
Upgrade¶
To upgrade CRDs for Logging you need to execute the command:
Warning! Never use the kubectl apply command! This command will generate the annotation
kubectl.kubernetes.io/last-applied-configuration that will contain the whole content of CRD.
It means that the object size will be increasing two times and it may lead to problems with storing
this CRD in Etcd.
For example, if you will use the archive with CRDs providing Logging:
mkdir /tmp/crds/
unzip -d /tmp/crds/ logging-operator-<version>-crds.zip
kubectl replace -f /tmp/crds/*
Remove¶
Warning! This step removes all CRDs for Logging and deleting these CRDs causes the deletion of
all resources of their type in all namespaces.
It means that all resources like LoggingService from applications are removed.
To remove CRDs and all Custom Resources (CRs) LoggingService from all namespaces for Logging
you need to execute the command: