Add draft for IpAddress

Author: jstudler

api/v1/ipaddress_types.go

@@ -31,26 +31,37 @@ type IpAddressSpec struct {
 	//+kubebuilder:validation:Format=cidr
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'ipAddress' is immutable"
 	//+kubebuilder:validation:Required
+	// The actual IP Address that should be reserved in NetBox
 	IpAddress string `json:"ipAddress"`
 
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
+	// The NetBox Tenant to be used for creating this resource in Netbox
 	Tenant string `json:"tenant,omitempty"`
 
+	// NetBox Custom Fields that should be added to the resource in NetBox. Note that currently only Text Type is supported (GitHub #129)
 	CustomFields map[string]string `json:"customFields,omitempty"`
 
+	// Comment that should be added to the resource in NetBox
 	Comments string `json:"comments,omitempty"`
 
+	// Description that should be added to the resource in NetBox
 	Description string `json:"description,omitempty"`
 
+	// preserveInNetbox defines whether or not the Resource should stay in NetBox when the Kubernetes Resource is deleted
+	// When set to true, the resource will not be deleted in NetBox upon CR deletion
+	// When set to false, the resource will be cleaned up in NetBox upon CR deletion
+	// If you want to restore resources from NetBox (e.g. recreation of an entire cluster), preserveInNetbox set to true is a prerequisite.
 	PreserveInNetbox bool `json:"preserveInNetbox,omitempty"`
 }
 
 // IpAddressStatus defines the observed state of IpAddress
 type IpAddressStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
+	// The ID of the resource in NetBox
 	IpAddressId int64 `json:"id,omitempty"`
 
+	// The URL to the NetBox UI to display this resource. Note that the base depends on the runtime config of NetBox Operator
 	IpAddressUrl string `json:"url,omitempty"`
 
 	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

config/crd/bases/netbox.dev_ipaddresses.yaml

@@ -58,22 +58,35 @@ spec:
             description: IpAddressSpec defines the desired state of IpAddress
             properties:
               comments:
+                description: Comment that should be added to the resource in NetBox
                 type: string
               customFields:
                 additionalProperties:
                   type: string
+                description: 'NetBox Custom Fields that should be added to the resource
+                  in NetBox. Note that currently only Text Type is supported (GitHub
+                  #129)'
                 type: object
               description:
+                description: Description that should be added to the resource in NetBox
                 type: string
               ipAddress:
+                description: The actual IP Address that should be reserved in NetBox
                 format: cidr
                 type: string
                 x-kubernetes-validations:
                 - message: Field 'ipAddress' is immutable
                   rule: self == oldSelf
               preserveInNetbox:
+                description: |-
+                  preserveInNetbox defines whether or not the Resource should stay in NetBox when the Kubernetes Resource is deleted
+                  When set to true, the resource will not be deleted in NetBox upon CR deletion
+                  When set to false, the resource will be cleaned up in NetBox upon CR deletion
+                  If you want to restore resources from NetBox (e.g. recreation of an entire cluster), preserveInNetbox set to true is a prerequisite.
                 type: boolean
               tenant:
+                description: The NetBox Tenant to be used for creating this resource
+                  in Netbox
                 type: string
                 x-kubernetes-validations:
                 - message: Field 'tenant' is immutable
@@ -144,9 +157,12 @@ spec:
                 description: |-
                   INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
                   Important: Run "make" to regenerate code after modifying this file
+                  The ID of the resource in NetBox
                 format: int64
                 type: integer
               url:
+                description: The URL to the NetBox UI to display this resource. Note
+                  that the base depends on the runtime config of NetBox Operator
                 type: string
             type: object
         type: object