github.com/koderover/helm@v2.17.0+incompatible/_proto/hapi/chart/metadata.proto (about)

     1  // Copyright The Helm Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  syntax = "proto3";
    16  
    17  package hapi.chart;
    18  
    19  option go_package = "chart";
    20  
    21  // Maintainer describes a Chart maintainer.
    22  message Maintainer {
    23  	// Name is a user name or organization name
    24  	string name = 1;
    25  
    26  	// Email is an optional email address to contact the named maintainer
    27  	string email = 2;
    28  
    29  	// Url is an optional URL to an address for the named maintainer
    30  	string url = 3;
    31  }
    32  
    33  //	Metadata for a Chart file. This models the structure of a Chart.yaml file.
    34  //
    35  // 	Spec: https://k8s.io/helm/blob/master/docs/design/chart_format.md#the-chart-file
    36  message Metadata {
    37  	enum Engine {
    38  		UNKNOWN = 0;
    39  		GOTPL = 1;
    40  	}
    41  	// The name of the chart
    42  	string name = 1;
    43  
    44  	// The URL to a relevant project page, git repo, or contact person
    45  	string home = 2;
    46  
    47  	// Source is the URL to the source code of this chart
    48  	repeated string sources = 3;
    49  
    50  	// A SemVer 2 conformant version string of the chart
    51  	string version = 4;
    52  
    53  	// A one-sentence description of the chart
    54  	string description = 5;
    55  
    56  	// A list of string keywords
    57  	repeated string keywords = 6;
    58  
    59  	// A list of name and URL/email address combinations for the maintainer(s)
    60  	repeated Maintainer maintainers = 7;
    61  
    62  	// The name of the template engine to use. Defaults to 'gotpl'.
    63  	string engine = 8;
    64  
    65  	// The URL to an icon file.
    66  	string icon = 9;
    67  
    68  	// The API Version of this chart.
    69  	string apiVersion = 10;
    70  
    71  	// The condition to check to enable chart
    72  	string condition = 11;
    73  
    74  	// The tags to check to enable chart
    75  	string tags = 12;
    76  
    77  	// The version of the application enclosed inside of this chart.
    78  	string appVersion = 13;
    79  
    80  	// Whether or not this chart is deprecated
    81  	bool deprecated = 14;
    82  
    83  	// TillerVersion is a SemVer constraints on what version of Tiller is required.
    84  	// See SemVer ranges here: https://github.com/Masterminds/semver#basic-comparisons
    85  	string tillerVersion = 15;
    86  
    87  	// Annotations are additional mappings uninterpreted by Tiller,
    88  	// made available for inspection by other applications.
    89  	map<string,string> annotations = 16;
    90  
    91  	// KubeVersion is a SemVer constraint specifying the version of Kubernetes required.
    92          string kubeVersion = 17;
    93  }