devconsole-api

module
v0.0.0-...-244201a Latest Latest
Warning

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

Go to latest
Published: May 2, 2019 License: Apache-2.0

README

Overview

The canonical location of the OpenShift DevConsole API definition. This repo holds the API type definitions and serialization code used by DevConsole Operator

Prerequisites

Build API

$ make build

Regenerate deepcopy after modifying API:

$ make generate

Add a new API for the custom resource

New API for the custom resource can be generated in DevConsole Operator and then moved to this repo:

$ cd $GOPATH/src/github.com/redhat-developer/devconsole-operator

# Add a new API for the custom resource <NewResourceKind>
$ operator-sdk add api --api-version=devconsole.openshift.io/v1alpha1 --kind=<NewResourceKind>

# Move generated API to devconsole-api
$ rsync -avh --progress ./pkg/apis/devconsole/ $GOPATH/src/github.com/redhat-developer/devconsole-api/pkg/apis/devconsole/

# Remove generated API from devconsole-operator
$ rm -rf ./pkg/apis

$ cd $GOPATH/src/github.com/redhat-developer/devconsole-api

# Edit your API
# ...

# Re-generate deepcopy
$ make generate

Directories

Path Synopsis
pkg
apis/devconsole/v1alpha1
Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io
Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io

Jump to

Keyboard shortcuts

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