From 88ed4a12ccae095b4341aa1acc972154b2d9be4b Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Tue, 16 Jan 2024 14:04:51 +0100 Subject: [PATCH] doc: add Go API documentation index files for storage backends Signed-off-by: Niels de Vos --- api/deploy/kubernetes/cephfs/doc.go | 20 ++++++++++++++++++++ api/deploy/kubernetes/nfs/doc.go | 20 ++++++++++++++++++++ api/deploy/kubernetes/rbd/doc.go | 20 ++++++++++++++++++++ 3 files changed, 60 insertions(+) create mode 100644 api/deploy/kubernetes/cephfs/doc.go create mode 100644 api/deploy/kubernetes/nfs/doc.go create mode 100644 api/deploy/kubernetes/rbd/doc.go diff --git a/api/deploy/kubernetes/cephfs/doc.go b/api/deploy/kubernetes/cephfs/doc.go new file mode 100644 index 000000000..06c50f7d4 --- /dev/null +++ b/api/deploy/kubernetes/cephfs/doc.go @@ -0,0 +1,20 @@ +/* +Copyright 2024 The Ceph-CSI Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package cephfs contains functions to obtain standard and recommended +// deployment artifacts for the CephFS CSI-driver on Kubernetes. These +// artifacts can be used by automation tools that want to deploy Ceph-CSI. +package cephfs diff --git a/api/deploy/kubernetes/nfs/doc.go b/api/deploy/kubernetes/nfs/doc.go new file mode 100644 index 000000000..bd8c99fd0 --- /dev/null +++ b/api/deploy/kubernetes/nfs/doc.go @@ -0,0 +1,20 @@ +/* +Copyright 2021 The Ceph-CSI Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package nfs contains functions to obtain standard and recommended deployment +// artifacts for the NFS CSI-driver on Kubernetes. These artifacts can be used +// by automation tools that want to deploy Ceph-CSI. +package nfs diff --git a/api/deploy/kubernetes/rbd/doc.go b/api/deploy/kubernetes/rbd/doc.go new file mode 100644 index 000000000..f4785f9e7 --- /dev/null +++ b/api/deploy/kubernetes/rbd/doc.go @@ -0,0 +1,20 @@ +/* +Copyright 2021 The Ceph-CSI Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package rbd contains functions to obtain standard and recommended deployment +// artifacts for the RBD CSI-driver on Kubernetes. These artifacts can be used +// by automation tools that want to deploy Ceph-CSI. +package rbd