Text file src/github.com/openshift/custom-resource-status/README.md

Documentation: github.com/openshift/custom-resource-status

     1Custom Resource Status
     2======================
     3
     4[![Go Report Card](https://goreportcard.com/badge/github.com/openshift/custom-resource-status)](https://goreportcard.com/report/github.com/openshift/custom-resource-status)
     5[![Go Doc](https://godoc.org/github.com/openshift/custom-resource-status?status.svg)](http://godoc.org/github.com/openshift/custom-resource-status)
     6[![GitHub Issues](https://img.shields.io/github/issues/openshift/custom-resource-status.svg)](https://github.com/openshift/custom-resource-status/issues)
     7[![Licensed under Apache License version 2.0](https://img.shields.io/github/license/openshift/custom-resource-status.svg?maxAge=2592000)](https://www.apache.org/licenses/LICENSE-2.0)
     8
     9The purpose of this project is to provide some level of standardization and
    10best-practices with respect to managing the status of custom resources. This project
    11steals, err draws from:
    12
    13* [Cluster Version Operator (CVO)](https://github.com/openshift/cluster-version-operator)
    14  that manages essential OpenShift operators.
    15* [ClusterOperator Custom Resource](https://github.com/openshift/cluster-version-operator/blob/master/docs/dev/clusteroperator.md#what-should-an-operator-report-with-clusteroperator-custom-resource)
    16  that exists for operators managed by CVO to communicate their status.
    17* [openshift/library-go ClusterOperator status helpers](https://github.com/openshift/library-go/blob/master/pkg/config/clusteroperator/v1helpers/status.go)
    18  that makes it easy to manage the status on a ClusterOperator resource.
    19
    20The goal here is to prescribe, without mandate, how to meaningfully populate the
    21status of the Custom Resources your operator manages. Types, constants, and
    22functions are provided for the following:
    23
    24* [Conditions](conditions/README.md)
    25* [Object References](objectreferences/README.md)

View as plain text