api

package module

v0.0.0-...-e9d93e3 Latest Latest Go to latest Published: Feb 5, 2020 License: Apache-2.0 Imports: 52 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

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:

Base your pull request to this repo on latest openshift/api#master and ensure CI is green
Base your pull request to openshift/origin on latest openshift/origin#master
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:

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

Documentation ¶

Index ¶

Variables

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.

Source Files ¶

View all Source files

install.go

Directories ¶

Path	Synopsis
annotations
apps
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.
authorization
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.
build
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.
config
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.
console
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
alpha-build-machinery
alpha-build-machinery/make
alpha-build-machinery/make/lib
alpha-build-machinery/make/targets
alpha-build-machinery/make/targets/golang
alpha-build-machinery/make/targets/openshift
alpha-build-machinery/make/targets/openshift/operator
alpha-build-machinery/scripts
image
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.
imageregistry
v1 +k8s:deepcopy-gen=package +groupName=imageregistry.operator.openshift.io	+k8s:deepcopy-gen=package +groupName=imageregistry.operator.openshift.io
kubecontrolplane
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
network
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.
oauth
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.
openshiftcontrolplane
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.
operator
v1 +kubebuilder:validation:Optional +groupName=operator.openshift.io	+kubebuilder:validation:Optional +groupName=operator.openshift.io
v1alpha1 +groupName=operator.openshift.io	+groupName=operator.openshift.io
osin
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
serialization
testing
project
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.
quota
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.
route
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.
samples
v1 +groupName=samples.operator.openshift.io Package v1 ist he v1 version of the API.	+groupName=samples.operator.openshift.io Package v1 ist he v1 version of the API.
security
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.
servicecertsigner
v1alpha1 +groupName=servicecertsigner.config.openshift.io	+groupName=servicecertsigner.config.openshift.io
template
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
v1alpha1
user
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.

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