https://github.com/redhat-cop/onboarding-manager

Provides a workflow for opinionated creation of namespaces in OpenShift
https://github.com/redhat-cop/onboarding-manager

container-cop

Last synced: about 1 year ago
JSON representation

Provides a workflow for opinionated creation of namespaces in OpenShift

• Host: GitHub
• URL: https://github.com/redhat-cop/onboarding-manager
• Owner: redhat-cop
• Created: 2019-08-21T18:05:26.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-28T21:07:33.000Z (over 6 years ago)
• Last Synced: 2025-04-09T22:11:11.580Z (about 1 year ago)
• Topics: container-cop
• Language: Go
• Homepage:
• Size: 4.79 MB
• Stars: 1
• Watchers: 14
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# OpenShift Onboarding Manager

OpenShift Onboarding Manager is an operator for OpenShift that provides an automated workflow for project creation in OpenShift.

In most real world use cases, its difficult for administrators to allow developers the ability to simply create their own projects or namespaces, while still being able to support multiple teams with various needs and various skillset levels. This operator provides more advanced workflows that allow cluster administrators to maintain order in their namespace sprawl while still allowing them to provide self service project creation to developers.

## Features

- [Personal Sandboxes for all Users](#personal-sandboxes-for-all-users)

- [Automatic Cleanup of Old Sandboxes](#automatic-cleanup-of-old-sandboxes)

### Personal Sanboxes for all Users

When a user logs in to OpenShift, Onboarding Manager creates a sandbox project for that user to use. This feature keys off of the `User` resource in OpenShift.

    $ oc whoami

    esauer

    $ oc get users

    NAME         UID                                    FULL NAME            IDENTITIES

    ...

    esauer       c5256c56-a3cd-11e9-a5af-fa163ef11dde   Eric Sauer           paas_ldap_provider:uid=esauer,cn=users,cn=accounts,dc=example,dc=com

    ...

    $ oc get projects

    $ oc projects

    You have access to the following projects and can switch between them with 'oc project ':

    esauer-sbx

If the project is deleted, Onboarding Manager will automatically recreate it.

    $ oc delete project esauer-sbx

    $ oc projects

    You have access to the following projects and can switch between them with 'oc project ':

    esauer-sbx

### Automatic Cleanup of Old Sandboxes

Onboarding Manager automatically cleans up Sandbox projects as they get old. This is done via a separate `CronJob` which, by default, runs **once an hour** and cleans up all projects with the `env=sandbox` label that are **older than 30 days**. These settings can all be changed by editing [deploy/cleanup-cronjob.yaml](deploy/cleanup-cronjob.yaml).

## Deployment

Creates sandbox projects for users.

Deploying the operator can be done by running:

    oc new-project onboarding-manager

    oc apply -f deploy/

## Building

Building the operator is also very simple.

    operator-sdk build quay.io/redhat-cop/onboarding-manager