configuration-service

README

Configuration Service

The configuration-service is a Keptn core component and used to manage resources for Keptn project-related entities, i.e., project, stage, and service. The entity model is shown below. To store the resources with version control, a git repository is used that is mounted as persistent volume. Besides, this service has functionality to upload the git repository to any Git-based service such as GitLab, GitHub, Bitbucket, etc.

Entity model

------------          ------------          ------------
|          | 1        |          | 1        |          |
| Project  |----------|  Stage   |----------| Service  |
|          |        * |          |        * |          |
------------          ------------          ------------
  1 \                   1  \                   1  \
     \ *                    \ *                    \ *
   ------------           ------------           ------------ 
   |          |           |          |           |          | 
   | Resource |           | Resource |           | Resource |  
   |          |           |          |           |          |  
   ------------           ------------           ------------ 

Installation

The configuration-service is installed as a part of keptn

Deploy in your Kubernetes cluster

To deploy the current version of the configuration-service in your Keptn Kubernetes cluster, use the files deploy/pvc.yaml and deploy/service.yaml from this repository and apply it.

kubectl apply -f deploy/pvc.yaml

kubectl apply -f deploy/service.yaml

Delete in your Kubernetes cluster

To delete a deployed configuration-service, use the files deploy/pvc.yaml and deploy/service.yaml from this repository and delete the Kubernetes resources:

kubectl delete -f deploy/pvc.yaml

kubectl delete -f deploy/service.yaml

Generate source from Swagger

If the swagger.yaml is updated with new endpoints or models, generate the new source by executing:

swagger generate server -A configuration-service -f ./swagger.yaml