api

package module
v0.0.0-...-538f3e8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2019 License: Apache-2.0 Imports: 50 Imported by: 0

README

api

The canonical location of the OpenShift API definition. This repo holds the API type definitions and serialization code used by openshift/client-go

pull request process

Pull requests that change API types in this repo that have corresponding "internal" API objects in the openshift/origin repo must be paired with a pull request to openshift/origin.

To ensure the corresponding origin pull request is ready to merge as soon as the pull request to this repo is merged:

  1. Base your pull request to this repo on latest openshift/api#master and ensure CI is green
  2. Base your pull request to openshift/origin on latest openshift/origin#master
  3. In your openshift/origin pull request:
    1. Add a TMP commit that points glide.yaml at your fork of openshift/api, and the branch of your pull request:

      - package: github.com/openshift/api
        repo:    https://github.com/<your-username>/api.git
        version: "<your-openshift-api-branch>"
      
    2. Update your bump(*) commit to include the result of running hack/update-deps.sh, which will pull in the changes from your openshift/api pull request

    3. Make sure CI is green on your openshift/origin pull request

    4. Get LGTM on your openshift/api pull request (for API changes) and your openshift/origin pull request (for code changes)

Once both pull requests are ready, the openshift/api pull request can be merged.

Then do the following with your openshift/origin pull request:

  1. Drop the TMP commit (pointing glide back at openshift/api#master)
  2. Rerun hack/update-deps.sh and update your bump(*) commit
  3. It can then be tagged and merged by CI

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// Install is a function which adds every version of every openshift group to a scheme
	Install = schemeBuilder.AddToScheme

	// InstallKube is a way to install all the external k8s.io/api types
	InstallKube = kubeSchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
v1
+groupName=apps.openshift.io Package v1 is the v1 version of the API.
+groupName=apps.openshift.io Package v1 is the v1 version of the API.
v1
+kubebuilder:validation:Optional +groupName=authorization.openshift.io Package v1 is the v1 version of the API.
+kubebuilder:validation:Optional +groupName=authorization.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=build.openshift.io Package v1 is the v1 version of the API.
+groupName=build.openshift.io Package v1 is the v1 version of the API.
v1
+kubebuilder:validation:Optional +groupName=config.openshift.io Package v1 is the v1 version of the API.
+kubebuilder:validation:Optional +groupName=config.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=console.openshift.io Package v1 is the v1 version of the API.
+groupName=console.openshift.io Package v1 is the v1 version of the API.
hack
docker10
Package docker10 is the docker10 version of the API.
Package docker10 is the docker10 version of the API.
dockerpre012
Package dockerpre012 is the dockerpre012 version of the API.
Package dockerpre012 is the dockerpre012 version of the API.
v1
+groupName=image.openshift.io Package v1 is the v1 version of the API.
+groupName=image.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=kubecontrolplane.config.openshift.io Package v1 is the v1 version of the API.
+groupName=kubecontrolplane.config.openshift.io Package v1 is the v1 version of the API.
legacyconfig
v1
+groupName=legacy.config.openshift.io Package v1 is deprecated and exists to ease a transition to current APIs
+groupName=legacy.config.openshift.io Package v1 is deprecated and exists to ease a transition to current APIs
v1
+groupName=network.openshift.io Package v1 is the v1 version of the API.
+groupName=network.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=oauth.openshift.io Package v1 is the v1 version of the API.
+groupName=oauth.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=openshiftcontrolplane.config.openshift.io Package v1 is the v1 version of the API.
+groupName=openshiftcontrolplane.config.openshift.io Package v1 is the v1 version of the API.
v1
+kubebuilder:validation:Optional +groupName=operator.openshift.io
+kubebuilder:validation:Optional +groupName=operator.openshift.io
v1alpha1
+groupName=operator.openshift.io
+groupName=operator.openshift.io
v1
+groupName=osin.config.openshift.io Package v1 is the v1 version of the API.
+groupName=osin.config.openshift.io Package v1 is the v1 version of the API.
pkg
v1
+groupName=project.openshift.io Package v1 is the v1 version of the API.
+groupName=project.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=quota.openshift.io Package v1 is the v1 version of the API.
+groupName=quota.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=route.openshift.io Package v1 is the v1 version of the API.
+groupName=route.openshift.io Package v1 is the v1 version of the API.
v1
+groupName=security.openshift.io Package v1 is the v1 version of the API.
+groupName=security.openshift.io Package v1 is the v1 version of the API.
v1alpha1
+groupName=servicecertsigner.config.openshift.io
+groupName=servicecertsigner.config.openshift.io
v1
+groupName=template.openshift.io Package v1 is the v1 version of the API.
+groupName=template.openshift.io Package v1 is the v1 version of the API.
tools
genswaggertypedocs
lifted from k8s.io/kubernetes so we can add methods to types
lifted from k8s.io/kubernetes so we can add methods to types
unidling
v1
+groupName=user.openshift.io Package v1 is the v1 version of the API.
+groupName=user.openshift.io Package v1 is the v1 version of the API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL