cms-controller-manager/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/szymongib/kyma

Links

Open Source Insights

README ¶

Content Management System (CMS) Controller Manager

Overview

CMS is a Kubernetes-native solution for managing content. It is built on top of the Asset Store and consists of the DocsTopic Controller and the ClusterDocsTopic Controller.

Prerequisites

Use the following tools to set up the project:

Usage

Run a local version

To run the application outside the cluster, run this command:

make run

Build a production version

To build the production Docker image, run this command:

IMG={image_name}:{image_tag} make docker-build

The variables are:

{image_name} which is the name of the output image. Use cms-controller-manager for the image name.
{image_tag} which is the tag of the output image. Use latest for the tag name.

Environment Variables

Use the following environment variables to configure the application:

Name	Required	Default	Description
APP_CLUSTER_DOCS_TOPIC_RELIST_INTERVALL	No	`5m`	The period of time after which the controller refreshes the status of a ClusterDocsTopic CR.
APP_CLUSTER_BUCKET_REGION	No		Specifies the location of the region in which the controller creates a ClusterBucket CR. If the field is empty, the controller creates the bucket under the default location.
APP_DOCS_TOPIC_RELIST_INTERVALL	No	`5m`	The period of time after which the controller refreshes the status of a DocsTopic CR
APP_BUCKET_REGION	No		Specifies the location of the region in which the controller creates a Bucket CR. If the field is empty, the controller creates the bucket under the default location.
APP_WEBHOOK_CFG_MAP_NAME	No	webhook-configmap	The name of the ConfigMap that contains webhook definitions.
APP_WEBHOOK_CFG_MAP_NAMESPACE	No	webhook-configmap	The namespace of the ConfigMap that contains webhook definitions.

Development

Install dependencies

This project uses dep as a dependency manager. To install all required dependencies, use the following command:

make resolve

Run tests

To run all unit tests, use the following command:

make test

Directories ¶

Path	Synopsis
cmd
manager
pkg
apis Package apis contains Kubernetes API groups.	Package apis contains Kubernetes API groups.
apis/cms Package cms contains cms API versions	Package cms contains cms API versions
apis/cms/v1alpha1 Package v1alpha1 contains API Schema definitions for the cms v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kyma-project/kyma/components/cms-controller-manager/pkg/apis/cms +k8s:defaulter-gen=TypeMeta +groupName=cms.kyma-project.io Package v1alpha1 contains API Schema definitions for the cms v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kyma-project/kyma/components/cms-controller-manager/pkg/apis/cms +k8s:defaulter-gen=TypeMeta +groupName=cms.kyma-project.io	Package v1alpha1 contains API Schema definitions for the cms v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kyma-project/kyma/components/cms-controller-manager/pkg/apis/cms +k8s:defaulter-gen=TypeMeta +groupName=cms.kyma-project.io Package v1alpha1 contains API Schema definitions for the cms v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kyma-project/kyma/components/cms-controller-manager/pkg/apis/cms +k8s:defaulter-gen=TypeMeta +groupName=cms.kyma-project.io
controller
controller/clusterdocstopic
controller/docstopic
handler/docstopic
handler/docstopic/automock Code generated by mockery v1.0.0 Code generated by mockery v1.0.0	Code generated by mockery v1.0.0 Code generated by mockery v1.0.0
handler/docstopic/pretty
source
webhook
webhookconfig
webhookconfig/automock Code generated by mockery v1.0.0 Code generated by mockery v1.0.0	Code generated by mockery v1.0.0 Code generated by mockery v1.0.0

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL