mirror of
https://github.com/ceph/ceph-csi.git
synced 2025-06-13 10:33:35 +00:00
deploy: add CSIDriver for NFS
The API is extended for generation of the NFS CSIDriver object. The YAML file under deploy/ was created by `yamlgen`. The contents of the csidriver.yaml file is heavily based on the upstream CSIDriver from the Kubernetes csi-driver-nfs project. Because ./tools/yamlgen uses the API, it gets copied under vendor/ . This causes two copies of the API to be included in the repository, but that can not be prevented, it seems. See-also: https://github.com/kubernetes-csi/csi-driver-nfs/blob/master/deploy/csi-nfs-driverinfo.yaml Signed-off-by: Niels de Vos <ndevos@redhat.com>
This commit is contained in:
committed by
mergify[bot]
parent
984119b30d
commit
87f87141be
74
api/deploy/kubernetes/nfs/csidriver.go
Normal file
74
api/deploy/kubernetes/nfs/csidriver.go
Normal file
@ -0,0 +1,74 @@
|
||||
/*
|
||||
Copyright 2022 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
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
_ "embed"
|
||||
"fmt"
|
||||
"text/template"
|
||||
|
||||
"github.com/ghodss/yaml"
|
||||
storagev1 "k8s.io/api/storage/v1"
|
||||
)
|
||||
|
||||
//go:embed csidriver.yaml
|
||||
var csiDriver string
|
||||
|
||||
type CSIDriverValues struct {
|
||||
Name string
|
||||
}
|
||||
|
||||
var CSIDriverDefaults = CSIDriverValues{
|
||||
Name: "nfs.csi.ceph.com",
|
||||
}
|
||||
|
||||
// NewCSIDriver takes a driver name from the CSIDriverValues struct and
|
||||
// replaces the value in the template. A CSIDriver object is returned which can
|
||||
// be created in the Kubernetes cluster.
|
||||
func NewCSIDriver(values CSIDriverValues) (*storagev1.CSIDriver, error) {
|
||||
data, err := NewCSIDriverYAML(values)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
driver := &storagev1.CSIDriver{}
|
||||
err = yaml.Unmarshal([]byte(data), driver)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed convert YAML to %T: %w", driver, err)
|
||||
}
|
||||
|
||||
return driver, nil
|
||||
}
|
||||
|
||||
// NewCSIDriverYAML takes a driver name from the CSIDriverValues struct and
|
||||
// replaces the value in the template. A CSIDriver object in YAML is returned
|
||||
// which can be created in the Kubernetes cluster.
|
||||
func NewCSIDriverYAML(values CSIDriverValues) (string, error) {
|
||||
var buf bytes.Buffer
|
||||
|
||||
tmpl, err := template.New("CSIDriver").Parse(csiDriver)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to parse template: %w", err)
|
||||
}
|
||||
err = tmpl.Execute(&buf, values)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to replace values in template: %w", err)
|
||||
}
|
||||
|
||||
return buf.String(), nil
|
||||
}
|
9
api/deploy/kubernetes/nfs/csidriver.yaml
Normal file
9
api/deploy/kubernetes/nfs/csidriver.yaml
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
apiVersion: storage.k8s.io/v1
|
||||
kind: CSIDriver
|
||||
metadata:
|
||||
name: "{{ .Name }}"
|
||||
spec:
|
||||
attachRequired: false
|
||||
volumeLifecycleModes:
|
||||
- Persistent
|
38
api/deploy/kubernetes/nfs/csidriver_test.go
Normal file
38
api/deploy/kubernetes/nfs/csidriver_test.go
Normal file
@ -0,0 +1,38 @@
|
||||
/*
|
||||
Copyright 2022 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
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestNewCSIDriver(t *testing.T) {
|
||||
driver, err := NewCSIDriver(CSIDriverDefaults)
|
||||
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, driver)
|
||||
require.Equal(t, driver.Name, CSIDriverDefaults.Name)
|
||||
}
|
||||
|
||||
func TestNewCSIDriverYAML(t *testing.T) {
|
||||
yaml, err := NewCSIDriverYAML(CSIDriverDefaults)
|
||||
|
||||
require.NoError(t, err)
|
||||
require.NotEqual(t, "", yaml)
|
||||
}
|
Reference in New Issue
Block a user