• Stars
    star
    163
  • Rank 231,141 (Top 5 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created almost 8 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Examples and Components for deploying into OpenShift

OpenShift Image Streams and Templates

This repository contains a curated set of image streams and templates for OpenShift. See the official OpenShift documentation for more information about image streams and templates.

Overview

Official

Provided and supported by Red Hat, official Templates and ImageStreams are listed in the top level of this repository, making it easy for developers to get started creating applications with the newest technologies.

You can check to see which of the official Templates and ImageStreams are available in your OpenShift cluster by doing one of the following:

  • Log into the web console and click Add to Project

  • List them for the openshift project using the Command Line Interface

    $ oc get templates -n openshift
    $ oc get imagestreams -n openshift

Community

Community templates and image streams are not provided or supported by Red Hat. This curated list of community maintained resources exemplify OpenShift best practices and provide clear documentation to serve as a reference for other developers.

Building the Library

You must build the library executable before you can run the import.

# requires go 1.13+
$ make build

Running the Script

# Imports the official.yaml and community.yaml without any
# additional flags or filters
$ make import

# Increase the log level
# Supported levels: 0,2,5,8
$ make import LOGLEVEL=2

# Imports the templates and imagestreams into some_dir
$ make import DIR=some_dir

# Imports only the foo.yaml and bar.yaml documents
$ make import DOCUMENTS=foo.yaml,bar.yaml

# Imports only the templates and imagestreams tagged with
# tag1 OR tag2
$ make import TAGS=tag1,tag2

# Imports only the templates and imagestreams tagged with
# tag1 AND tag2
$ make import TAGS=tag1,tag2 MATCHALL=true

Verifying Your Updates

$ make verify

The make verify command runs the following checks:

  • verifies the Go syntax (using gofmt)
  • verifies that make import has been run

Contributing

Adding Your Template or ImageStream

  • Fork the openshift/library repository on github
  • Add your template or image stream to the community.yaml or official.yaml file in the top level of this project
  • Run the make import command and make sure that your template(s) and/or image-stream(s) are processed and written to the correct directory under the community or official folder and that no errors have occurred.
  • Run the make verify command and ensure that no errors occur
  • Commit and push your changes to your fork of the github repository
    • Make sure to commit any changes in the community and official folders
  • Create a pull request against the openshift/library upstream repository

That's it! Your pull request will be reviewed by a member of the OpenShift Team and merged if everything looks good.

YAML file structure:

variables: # (optional) top level block item
  <variable_name>: <value> # (optional)
data: # (required) top level block item
  <folder_name>: # (required) folder that the below items will be stored in
    imagestreams: # (optional) list of image-streams to process into the above folder
      - location: # (required) github url to a json file or folder of json files
        regex: # (optional) matched against ['metadata']['name'] in the json file
        suffix: # (optional) suffix for the file that is created ex: ruby-<suffix>.json
        docs: # (optional) web address of the documentation for this image-stream
    templates: # (optional) list of templates to process into the above folder
      - location: # (required) github url to a template or folder of templates in json format
        regex: # (optional) matched against ['metadata']['name'] in the json file
        suffix: # (optional) suffix for the file that is created ex: ruby-<suffix>.json
        docs: # (optional) web address of the documentation for this template

Variables

Anything under the data block can contain a reference to a variable by using the following syntax:

{variable_name}

You must also specify a value for that variable name under the variables block with the following syntax:

<variable_name>: <value>

Organization

Listings in the official.yaml file will be created in a sub folder of the official top level folder. Listings in the community.yaml file will be created in a sub folder of the community top level folder.

folder_name

The folder_name is a sub folder which represents a logical grouping for a set of templates or image-streams in the top level official or community folders.

location

The location must be a publicly available url that points to either a template, image-stream, or image-stream list file in JSON or YAML format

docs

The docs is a field to list the web address of the documentation for the template, image-stream, or image-stream list

regex

The regex is a plain string that is matched against the ['metadata']['name'] element in the template or image-stream. Make sure that the regex string that you provide is descriptive enough to only match the ['metadata']['name'] that you are trying to target.

suffix

The suffix is applied to the end of the filename that is created right before the .json file extension and can contain dashes (-) or underscores (_).

Additional information

Creating templates, image-streams, and image-stream lists

You can find more information about creating templates and image-streams in the official OpenShift Documentation. Below are some quick links to important sections:

More Repositories

1

origin

Conformance test suite for OpenShift
Go
8,372
star
2

source-to-image

A tool for building artifacts from source and injecting into container images
Go
2,379
star
3

openshift-ansible

Install and config an OpenShift 3.x cluster
Python
2,136
star
4

osin

Golang OAuth2 server library
Go
1,832
star
5

installer

Install an OpenShift 4.x cluster
1,312
star
6

okd

The self-managing, auto-upgrading, Kubernetes distribution for everyone
HCL
1,276
star
7

origin-server

OpenShift 2 (deprecated)
Ruby
885
star
8

openshift-docs

OpenShift 3 and 4 product and community documentation
HTML
687
star
9

microshift

A small form factor OpenShift/Kubernetes optimized for edge computing
Go
528
star
10

geard

geard is no longer maintained - see OpenShift 3 and Kubernetes
Go
407
star
11

hypershift

Hyperscale OpenShift - clusters with hosted control planes
Go
347
star
12

console

OpenShift Cluster Console UI
TypeScript
334
star
13

openshift-ansible-contrib

Additional roles and playbooks for OpenShift installation and management
Python
284
star
14

training

Shell
280
star
15

pipelines-tutorial

A step-by-step tutorial showing OpenShift Pipelines
Shell
272
star
16

jenkins

Shell
260
star
17

release

Release tooling for OpenShift
Shell
229
star
18

ansible-service-broker

Ansible Service Broker
Go
226
star
19

hive

API driven OpenShift cluster provisioning and management
Go
222
star
20

rhc

OpenShift 2 Client Tools (deprecated)
Ruby
220
star
21

machine-config-operator

Go
218
star
22

jenkins-client-plugin

Java
218
star
23

cluster-monitoring-operator

Manage the OpenShift monitoring stack
Go
218
star
24

openshift-restclient-python

Python client for the OpenShift API
Python
205
star
25

openshift-tools

A public repository of scripts used by OpenShift Operations for various purposes
Python
161
star
26

enhancements

Enhancements tracking repository for OKD
Go
156
star
27

generic-admission-server

A library for writing admission webhooks based on k8s.io/apiserver
Go
153
star
28

oc

The OpenShift Command Line, part of OKD
Go
150
star
29

origin-aggregated-logging

JavaScript
142
star
30

machine-api-operator

Machine API operator
Go
137
star
31

origin-web-console

Web Console for the OpenShift Application Platform
JavaScript
123
star
32

svt

Shell
117
star
33

imagebuilder

Builds Dockerfile using the Docker client (with squashing! and secrets!)
Go
116
star
34

client-go

Go client for OpenShift
Shell
104
star
35

compliance-operator

Operator providing OpenShift cluster compliance checks
Go
100
star
36

telemeter

Prometheus push federation
Go
96
star
37

assisted-service

Go
90
star
38

cluster-network-operator

Create and manage cluster networking configuration
Go
85
star
39

cincinnati

Rust
84
star
40

vagrant-openshift

Ruby
83
star
41

cluster-logging-operator

Operator to support logging subsystem of OpenShift
Go
83
star
42

openshift-pep

Public Project Enhancement Proposals for the OpenShift product. Tracks and maintains high level architectural documents related to future OpenShift changes.
82
star
43

jenkins-plugin

Java
81
star
44

sriov-network-operator

SR-IOV Network Operator
Go
81
star
45

origin-metrics

Shell
78
star
46

openshift-restclient-java

Java
78
star
47

must-gather

A client tool for gathering information about an operator managed component.
Shell
77
star
48

api

Canonical location of the OpenShift API definition.
Go
75
star
49

sdn

Go
73
star
50

cluster-version-operator

Go
72
star
51

library-go

Helpers for going from apis and clients to useful runtime constructs
Go
72
star
52

os

Shell
71
star
53

cluster-etcd-operator

Operator to manage the lifecycle of the etcd members of an OpenShift cluster
Go
70
star
54

cluster-node-tuning-operator

Manage node-level tuning by orchestrating the tuned daemon.
Go
69
star
55

openshift-sdn

Go
69
star
56

openshift-origin-design

Design repository for all things OpenShift
SCSS
68
star
57

autoheal

Autoheals based on monitoring alerts
Go
66
star
58

elasticsearch-operator

Go
66
star
59

cluster-kube-apiserver-operator

The kube-apiserver operator installs and maintains the kube-apiserver on a cluster
Go
65
star
60

oadp-operator

OADP Operator
Go
64
star
61

openshift-java-client

Java Client for the OpenShift REST API
Java
63
star
62

rosa

Go
61
star
63

ovn-kubernetes

Kubernetes integration for OVN
Go
61
star
64

community

Community organizational documentations and process for OKD
61
star
65

federation-dev

Dev preview of federation
Shell
59
star
66

cluster-ingress-operator

The Cluster Ingress Operator manages highly available network ingress for OpenShift
Go
59
star
67

oc-mirror

Lifecycle manager for internet-disconnected OpenShift environments
Go
58
star
68

openshift-client-python

A python library for interacting with OpenShift via the OpenShift client binary.
Python
56
star
69

cincinnati-graph-data

Release node and upgrade edge metadata for Cincinnati graphs.
Python
56
star
70

router

Ingress controller for OpenShift
Go
55
star
71

cluster-image-registry-operator

The image registry operator installs+maintains the internal registry on a cluster
Go
55
star
72

cluster-operator

Go
52
star
73

local-storage-operator

Operator for local storage
Go
51
star
74

tektoncd-pipeline-operator

tektoncd-pipeline operator for Kubernetes to manage installation, updation and uninstallation of tekton-cd pipelines.
Go
51
star
75

pipelines-catalog

A repository for OpenShift Pipelines tasks
Python
50
star
76

openshift-azure

Azure Red Hat Openshift
Go
49
star
77

cloud-credential-operator

Manage cloud provider credentials as Kubernetes CRDs
Go
48
star
78

assisted-installer

Go
48
star
79

verification-tests

Blackbox test suite for OpenShift.
Gherkin
47
star
80

community.okd

OKD/Openshift collection for Ansible
Python
45
star
81

service-idler

A controller for idling and unidling groups of scalable Kubernetes resources
Go
44
star
82

ruby-hello-world

Hello world ruby sample for OpenShift v3
Ruby
44
star
83

managed-cluster-config

Static deployable artifacts for managed OSD clusters
HTML
42
star
84

cluster-authentication-operator

OpenShift operator for the top level Authentication and OAuth configs.
Go
41
star
85

image-registry

OpenShift cluster image registry
Go
40
star
86

sriov-cni

An SRIOV CNI plugin
Go
38
star
87

console-operator

The console operator installs and maintains the web console on a cluster
Go
38
star
88

openshift-extras

Unofficial tools for use with OpenShift
Ruby
38
star
89

runbooks

Runbooks for Alerts on OCP
Shell
37
star
90

cluster-kube-controller-manager-operator

The kube-controller-manager operator installs and maintains the kube-controller-manager on a cluster
Go
37
star
91

cluster-kube-descheduler-operator

An operator to run descheduler on OpenShift.
Go
37
star
92

assisted-test-infra

Python
36
star
93

windows-machine-config-operator

Windows MCO for OpenShift that handles addition of Windows nodes to the cluster
Go
36
star
94

insights-operator

Go
36
star
95

service-ca-operator

Controller to mint and manage serving certificates for Kubernetes services
Go
36
star
96

openshift-jee-sample

A sample app to be deployed on openshift environments
HTML
35
star
97

cluster-autoscaler-operator

Manage Kubernetes cluster-autoscaler deployments
Go
35
star
98

certman-operator

Operator to Manage Let's Encrypt certificates for OpenShift Clusters
Go
35
star
99

python-interface

Python
35
star
100

cluster-dns-operator

The Cluster DNS Operator manages cluster DNS services for OpenShift
Go
35
star