Skip to content

Commit 3b1baa3

Browse files
committed
Added keywords in operator metadata.
1 parent b549266 commit 3b1baa3

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

doc/design/building-your-csv.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
4+
5+
- [Building a Cluster Service Version (CSV) for the Operator Framework](#building-a-cluster-service-version-csv-for-the-operator-framework)
6+
- [What is a Cluster Service Version (CSV)?](#what-is-a-cluster-service-version-csv)
7+
- [CSV Metadata](#csv-metadata)
8+
- [Your Custom Resource Definitions](#your-custom-resource-definitions)
9+
- [Owned CRDs](#owned-crds)
10+
- [Required CRDs](#required-crds)
11+
- [CRD Templates](#crd-templates)
12+
- [Your API Services](#your-api-services)
13+
- [Owned APIServices](#owned-apiservices)
14+
- [APIService Resource Creation](#apiservice-resource-creation)
15+
- [APIService Serving Certs](#apiservice-serving-certs)
16+
- [Required APIServices](#required-apiservices)
17+
- [Operator Metadata](#operator-metadata)
18+
- [Operator Install](#operator-install)
19+
- [Full Examples](#full-examples)
20+
21+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
22+
123
# Building a Cluster Service Version (CSV) for the Operator Framework
224

325
This guide is intended to guide an Operator author to package a version of their Operator to run with the [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager). This will be a manual method that will walk through each section of the file, what it’s used for and how to populate it.
@@ -246,7 +268,8 @@ The metadata section contains general metadata around the name, version and othe
246268

247269
Here's an example:
248270

249-
```keywords: ['etcd', 'key value', 'database', 'coreos', 'open source']
271+
```yaml
272+
keywords: ['etcd', 'key value', 'database', 'coreos', 'open source']
250273
version: 0.9.2
251274
maturity: alpha
252275
replaces: etcdoperator.v0.9.0

0 commit comments

Comments
 (0)