...

Text file src/github.com/openshift/api/project/v1/generated.proto

Documentation: github.com/openshift/api/project/v1

     1
     2// This file was autogenerated by go-to-protobuf. Do not edit it manually!
     3
     4syntax = "proto2";
     5
     6package github.com.openshift.api.project.v1;
     7
     8import "k8s.io/api/core/v1/generated.proto";
     9import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
    10import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
    11
    12// Package-wide variables from generator "generated".
    13option go_package = "github.com/openshift/api/project/v1";
    14
    15// Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members,
    16// a quota on the resources that the project may consume, and the security controls on the resources in
    17// the project. Within a project, members may have different roles - project administrators can set
    18// membership, editors can create and manage the resources, and viewers can see but not access running
    19// containers. In a normal cluster project administrators are not able to alter their quotas - that is
    20// restricted to cluster administrators.
    21//
    22// Listing or watching projects will return only projects the user has the reader role on.
    23//
    24// An OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed
    25// as editable to end users while namespaces are not. Direct creation of a project is typically restricted
    26// to administrators, while end users should use the requestproject resource.
    27//
    28// Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
    29// +openshift:compatibility-gen:level=1
    30message Project {
    31  // metadata is the standard object's metadata.
    32  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    33  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    34
    35  // Spec defines the behavior of the Namespace.
    36  optional ProjectSpec spec = 2;
    37
    38  // Status describes the current status of a Namespace
    39  // +optional
    40  optional ProjectStatus status = 3;
    41}
    42
    43// ProjectList is a list of Project objects.
    44//
    45// Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
    46// +openshift:compatibility-gen:level=1
    47message ProjectList {
    48  // metadata is the standard list's metadata.
    49  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    50  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
    51
    52  // Items is the list of projects
    53  repeated Project items = 2;
    54}
    55
    56// ProjectRequest is the set of options necessary to fully qualify a project request
    57//
    58// Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
    59// +openshift:compatibility-gen:level=1
    60message ProjectRequest {
    61  // metadata is the standard object's metadata.
    62  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    63  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    64
    65  // DisplayName is the display name to apply to a project
    66  optional string displayName = 2;
    67
    68  // Description is the description to apply to a project
    69  optional string description = 3;
    70}
    71
    72// ProjectSpec describes the attributes on a Project
    73message ProjectSpec {
    74  // Finalizers is an opaque list of values that must be empty to permanently remove object from storage
    75  repeated string finalizers = 1;
    76}
    77
    78// ProjectStatus is information about the current status of a Project
    79message ProjectStatus {
    80  // Phase is the current lifecycle phase of the project
    81  // +optional
    82  optional string phase = 1;
    83
    84  // Represents the latest available observations of the project current state.
    85  // +optional
    86  // +patchMergeKey=type
    87  // +patchStrategy=merge
    88  repeated k8s.io.api.core.v1.NamespaceCondition conditions = 2;
    89}
    90

View as plain text