Merge pull request k8snetworkplumbingwg#705 from zeeke/config-align

Update `config/` folder
Mellanox · Jun 5, 2024 · 7d6ccd2 · 7d6ccd2
2 parents 8d32f42 + aa21f55
commit 7d6ccd2
Show file tree

Hide file tree

Showing 16 changed files with 315 additions and 218 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -74,6 +74,16 @@ jobs:
     - name: check go modules are up to date
       run: make check-deps
 
+  manifests:
+    name: check manifests
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+
+    - name: check if the config/ folder is up to date
+      run: make check-manifests
+
   golangci:
     name: Golangci-lint
     runs-on: ubuntu-latest

diff --git a/Makefile b/Makefile
@@ -109,6 +109,11 @@ manifests: controller-gen
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) webhook paths="./..." output:crd:artifacts:config=$(CRD_BASES)
 	cp ./config/crd/bases/* ./deployment/sriov-network-operator/crds/
 
+check-manifests: manifests
+	@set +e; git diff --quiet config; \
+	if [ $$? -eq 1 ]; \
+	then echo -e "\n`config` folder is out of date. Please run `make manifests` and commit your changes"; \
+	exit 1; fi
 
 sync-manifests-%: manifests
 	@mkdir -p manifests/$*

diff --git a/config/crd/bases/sriovnetwork.openshift.io_ovsnetworks.yaml b/config/crd/bases/sriovnetwork.openshift.io_ovsnetworks.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.0
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: ovsnetworks.sriovnetwork.openshift.io
 spec:
   group: sriovnetwork.openshift.io
@@ -21,27 +20,34 @@ spec:
         description: OVSNetwork is the Schema for the ovsnetworks API
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
           spec:
             description: OVSNetworkSpec defines the desired state of OVSNetwork
             properties:
               bridge:
-                description: name of the OVS bridge, if not set OVS will automatically
-                  select bridge based on VF PCI address
+                description: |-
+                  name of the OVS bridge, if not set OVS will automatically select bridge
+                  based on VF PCI address
                 type: string
               capabilities:
-                description: 'Capabilities to be configured for this network. Capabilities
-                  supported: (mac|ips), e.g. ''{"mac": true}'''
+                description: |-
+                  Capabilities to be configured for this network.
+                  Capabilities supported: (mac|ips), e.g. '{"mac": true}'
                 type: string
               interfaceType:
                 description: The type of interface on ovs.

diff --git a/config/crd/bases/sriovnetwork.openshift.io_sriovibnetworks.yaml b/config/crd/bases/sriovnetwork.openshift.io_sriovibnetworks.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.0
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: sriovibnetworks.sriovnetwork.openshift.io
 spec:
   group: sriovnetwork.openshift.io
@@ -21,23 +20,29 @@ spec:
         description: SriovIBNetwork is the Schema for the sriovibnetworks API
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
           spec:
             description: SriovIBNetworkSpec defines the desired state of SriovIBNetwork
             properties:
               capabilities:
-                description: 'Capabilities to be configured for this network. Capabilities
-                  supported: (infinibandGUID), e.g. ''{"infinibandGUID": true}'''
+                description: |-
+                  Capabilities to be configured for this network.
+                  Capabilities supported: (infinibandGUID), e.g. '{"infinibandGUID": true}'
                 type: string
               ipam:
                 description: IPAM configuration to be used for this network.
@@ -50,8 +55,9 @@ spec:
                 - disable
                 type: string
               metaPlugins:
-                description: MetaPluginsConfig configuration to be used in order to
-                  chain metaplugins to the sriov interface returned by the operator.
+                description: |-
+                  MetaPluginsConfig configuration to be used in order to chain metaplugins to the sriov interface returned
+                  by the operator.
                 type: string
               networkNamespace:
                 description: Namespace of the NetworkAttachmentDefinition custom resource

diff --git a/config/crd/bases/sriovnetwork.openshift.io_sriovnetworknodepolicies.yaml b/config/crd/bases/sriovnetwork.openshift.io_sriovnetworknodepolicies.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.0
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: sriovnetworknodepolicies.sriovnetwork.openshift.io
 spec:
   group: sriovnetwork.openshift.io
@@ -22,23 +21,29 @@ spec:
           API
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
           spec:
             description: SriovNetworkNodePolicySpec defines the desired state of SriovNetworkNodePolicy
             properties:
               bridge:
-                description: contains bridge configuration for matching PFs, valid
-                  only for eSwitchMode==switchdev
+                description: |-
+                  contains bridge configuration for matching PFs,
+                  valid only for eSwitchMode==switchdev
                 properties:
                   ovs:
                     description: contains configuration for the OVS bridge,

diff --git a/config/crd/bases/sriovnetwork.openshift.io_sriovnetworknodestates.yaml b/config/crd/bases/sriovnetwork.openshift.io_sriovnetworknodestates.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.0
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: sriovnetworknodestates.sriovnetwork.openshift.io
 spec:
   group: sriovnetwork.openshift.io
@@ -35,14 +34,19 @@ spec:
           API
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
@@ -81,8 +85,9 @@ spec:
                           description: name of the bridge
                           type: string
                         uplinks:
-                          description: uplink-level bridge configuration for each
-                            uplink(PF). currently must contain only one element
+                          description: |-
+                            uplink-level bridge configuration for each uplink(PF).
+                            currently must contain only one element
                           items:
                             description: OVSUplinkConfigExt contains configuration
                               for the concrete OVS uplink(PF)
@@ -206,8 +211,9 @@ spec:
                           description: name of the bridge
                           type: string
                         uplinks:
-                          description: uplink-level bridge configuration for each
-                            uplink(PF). currently must contain only one element
+                          description: |-
+                            uplink-level bridge configuration for each uplink(PF).
+                            currently must contain only one element
                           items:
                             description: OVSUplinkConfigExt contains configuration
                               for the concrete OVS uplink(PF)