...

Text file src/k8s.io/api/storagemigration/v1alpha1/generated.proto

Documentation: k8s.io/api/storagemigration/v1alpha1

     1/*
     2Copyright The Kubernetes Authors.
     3
     4Licensed under the Apache License, Version 2.0 (the "License");
     5you may not use this file except in compliance with the License.
     6You may obtain a copy of the License at
     7
     8    http://www.apache.org/licenses/LICENSE-2.0
     9
    10Unless required by applicable law or agreed to in writing, software
    11distributed under the License is distributed on an "AS IS" BASIS,
    12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13See the License for the specific language governing permissions and
    14limitations under the License.
    15*/
    16
    17
    18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
    19
    20syntax = "proto2";
    21
    22package k8s.io.api.storagemigration.v1alpha1;
    23
    24import "k8s.io/api/core/v1/generated.proto";
    25import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
    26import "k8s.io/apimachinery/pkg/runtime/generated.proto";
    27import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
    28
    29// Package-wide variables from generator "generated".
    30option go_package = "k8s.io/api/storagemigration/v1alpha1";
    31
    32// The names of the group, the version, and the resource.
    33message GroupVersionResource {
    34  // The name of the group.
    35  optional string group = 1;
    36
    37  // The name of the version.
    38  optional string version = 2;
    39
    40  // The name of the resource.
    41  optional string resource = 3;
    42}
    43
    44// Describes the state of a migration at a certain point.
    45message MigrationCondition {
    46  // Type of the condition.
    47  optional string type = 1;
    48
    49  // Status of the condition, one of True, False, Unknown.
    50  optional string status = 2;
    51
    52  // The last time this condition was updated.
    53  // +optional
    54  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 3;
    55
    56  // The reason for the condition's last transition.
    57  // +optional
    58  optional string reason = 4;
    59
    60  // A human readable message indicating details about the transition.
    61  // +optional
    62  optional string message = 5;
    63}
    64
    65// StorageVersionMigration represents a migration of stored data to the latest
    66// storage version.
    67message StorageVersionMigration {
    68  // Standard object metadata.
    69  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    70  // +optional
    71  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    72
    73  // Specification of the migration.
    74  // +optional
    75  optional StorageVersionMigrationSpec spec = 2;
    76
    77  // Status of the migration.
    78  // +optional
    79  optional StorageVersionMigrationStatus status = 3;
    80}
    81
    82// StorageVersionMigrationList is a collection of storage version migrations.
    83message StorageVersionMigrationList {
    84  // Standard list metadata
    85  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    86  // +optional
    87  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
    88
    89  // Items is the list of StorageVersionMigration
    90  // +patchMergeKey=type
    91  // +patchStrategy=merge
    92  // +listType=map
    93  // +listMapKey=type
    94  repeated StorageVersionMigration items = 2;
    95}
    96
    97// Spec of the storage version migration.
    98message StorageVersionMigrationSpec {
    99  // The resource that is being migrated. The migrator sends requests to
   100  // the endpoint serving the resource.
   101  // Immutable.
   102  optional GroupVersionResource resource = 1;
   103
   104  // The token used in the list options to get the next chunk of objects
   105  // to migrate. When the .status.conditions indicates the migration is
   106  // "Running", users can use this token to check the progress of the
   107  // migration.
   108  // +optional
   109  optional string continueToken = 2;
   110}
   111
   112// Status of the storage version migration.
   113message StorageVersionMigrationStatus {
   114  // The latest available observations of the migration's current state.
   115  // +patchMergeKey=type
   116  // +patchStrategy=merge
   117  // +listType=map
   118  // +listMapKey=type
   119  // +optional
   120  repeated MigrationCondition conditions = 1;
   121
   122  // ResourceVersion to compare with the GC cache for performing the migration.
   123  // This is the current resource version of given group, version and resource when
   124  // kube-controller-manager first observes this StorageVersionMigration resource.
   125  optional string resourceVersion = 2;
   126}
   127

View as plain text