Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 3.63 KB

README.md

File metadata and controls

66 lines (54 loc) · 3.63 KB
Raw

Additional Services and Configuration

This directory contains manifests and configuration for additional services that:

  1. are running on OpenShift CI cluster
  2. are not critical for the development process of the whole OpenShift organization (critical service configuration is in core-services).
  3. want to follow the same quality criteria and automated check and deployment process that the core services do (DPTP intends to support only these additional services).

How to add new service

Create a new directory for your service, containing all necessary files. You may copy the _TEMPLATE directory and start using the files there. Add manifests and other configuration as needed.

Quality criteria and conventions

  1. All directories should contain OWNERS and README.md files. This is enforced by make check-services locally and by the ci/prow/services-valid check on pull requests.
  2. Config is applied to the cluster using the applyconfig tool. The tool applies all YAML files under your service subdirectory. Subdirectories are searched recursively and directories with names starting with _ are skipped. All YAML filenames should follow the following convention:
    • All admin resources should be in admin_*.yaml files
    • Names of YAML files that should not be applied to the cluster should start with _.
    • The remaining YAML files are considered "standard" resources.
  3. applyconfig applies files in lexicographical order. In the case when some resources need to be created before others, this needs to be reflected by the naming of the files (e.g. by including a numerical component).
  4. The config-updater service account in the ci namespace must have permissions to apply all standard resources.
  5. Destination namespaces should always be specified within a manifest, never rely on a currently set OpenShift project.
  6. All ConfigMaps need to be set up for automated updates by the config-updater Prow plugin.

How to apply

There are three types of configuration: admin resources, other resources and ConfigMaps.

Automation

  1. Admin resources are not automatically applied to the cluster.
  2. Other resources are automatically applied to the cluster by a Prow postsubmit after each PR is merged, and also periodically.
  3. ConfigMaps are automatically updated by the config-updater Prow plugin, configured in its config.yaml file. Additionally, they are periodically synced by a Prow job.

Manual

  1. Admin resources can be created by users with --as=system:admin rights by make services-admin.
  2. Other resources can be created by make services, provided the user has rights to perform all necessary actions
  3. ConfigMaps can be manually created by the config-bootstrapper tool.

Additionally, the applyconfig can be used directly. See its README.md for more details.