Skip to content

Commit

Permalink
Merge pull request #1 from okd-project/gitops-operator
Browse files Browse the repository at this point in the history
Add GitOps Operator
  • Loading branch information
SupremeMortal authored Apr 15, 2024
2 parents b53aaaa + b503d5c commit e893313
Show file tree
Hide file tree
Showing 7 changed files with 159 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy-catalog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
push:
branches:
- main
- odf

jobs:
build-deploy:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ An opinionated catalog of operators adapted for [OKD](https://okd.io)
## What is OKD?
OKD is a community distribution of [Kubernetes](https://kubernetes.io/) (K8s), a collection of software and design patterns to operate applications at scale.

OKD shares many of the same underlying cluster components as the commerical distribution [RedHat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift).
OKD shares many of the same underlying cluster components as the commercial distribution [RedHat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift).

## What are Operators?
The [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) is the concept of running "meta" software within your cluster to manage your applications and supporting components.
Expand All @@ -23,13 +23,13 @@ Kubernetes, by nature, has a lot of different ways to accomplish the same thing

Within RedHat OpenShift, the private catalog contains distributions of opensource projects to suit a variety of standard workflow requirements. For example, [OpenShift Pipelines](https://docs.openshift.com/pipelines/latest/about/about-pipelines.html) is an OpenShift-tuned distribution of the opensource project [Tekton](https://tekton.dev/).

Similary, this public catalog contains packaged solutions to common usecases, based off opensource projects.
Similarly, this public catalog contains packaged solutions to common use cases, based off opensource projects.

In many cases we will use the same code and packaging that adapts operators for OpenShift but altered to remove trademarked branding related to RedHat.

## Why do you need OKD-adapted operators/applications?
Compared to many other Kubernetes distributions, OKD has additional security restrictions, assumptions and fetures that mean an operator or application that would work "out of the box" on a more vanilla Kubernetes distribution, does not function on OKD. For example, additional security profiles may need to be applied, or MachineConfigs applied to add node features.
Compared to many other Kubernetes distributions, OKD has additional security restrictions, assumptions and features that mean an operator or application that would work "out of the box" on a more vanilla Kubernetes distribution, does not function on OKD. For example, additional security profiles may need to be applied, or MachineConfigs applied to add node features.

## Contributing
This is a test project and we are seeking contributors. Please join the OKD Development Working Group or reach out on Slack in #openshift-users.
This is a test project and we are seeking contributors. Please join the OKD Development Working Group or reach out on Slack in #okd-dev.

Empty file removed catalog/.gitkeep
Empty file.
139 changes: 139 additions & 0 deletions catalog/gitops-operator/gitops-operator.v4.15.0-2024-04-14-112847.yaml

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions catalog/gitops-operator/gitops-operator.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
schema: olm.package
name: gitops-operator
defaultChannel: alpha
icon:
base64data:
type: image/png
---
schema: olm.channel
package: gitops-operator
name: alpha
entries:
- name: gitops-operator.v4.15.0-2024-04-14-112847
2 changes: 1 addition & 1 deletion docs/INSTALLING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Installing OKDerator Catalog
# Quick Start
`oc apply -f https://raw.githubusercontent.com/okd-project/okderators-catalog-index/main/install/okderators.catalogsource.yml`

Must be authenticated as a `cluster-admin`, if succeful the command will return
Must be authenticated as a `cluster-admin`, if successful the command will return

`catalogsource.operators.coreos.com/okderators created`
2 changes: 1 addition & 1 deletion install/okderators.catalogsource.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
displayName: OKDerators
image: 'quay.io/okderators/catalog-index:latest'
publisher: OKD Working Group
publisher: OKD Community
icon:
base64data: '' # Todo
mediatype: '' # Todo
Expand Down

0 comments on commit e893313

Please sign in to comment.