feat: rename CRD Kind to Instance (instances.paperclip.inc)

Rename PaperclipInstance -> Instance since the API group paperclip.inc
already provides the namespace. CRD is now instances.paperclip.inc.

- Kind: Instance
- Plural: instances
- API: paperclip.inc/v1alpha1
- Short name: pci

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: stubbi

.github/workflows/ci.yaml

@@ -39,7 +39,7 @@ jobs:
           # Detect bare r.Update/r.Create calls in the controller that bypass
           # controllerutil.CreateOrUpdate. Only r.Update(ctx, instance) and
           # r.Status().Update(ctx, instance) are allowed (CR-level updates).
-          VIOLATIONS=$(grep -n 'r\.Update(ctx,' internal/controller/paperclipinstance_controller.go \
+          VIOLATIONS=$(grep -n 'r\.Update(ctx,' internal/controller/instance_controller.go \
             | grep -v 'instance)' \
             | grep -v '// reconcile-guard:allow' || true)
           if [ -n "$VIOLATIONS" ]; then
@@ -230,7 +230,7 @@ jobs:
         run: |
           echo "=== Operator pod status ==="
           kubectl get pods -n paperclip-operator-system
-          echo "=== PaperclipInstance resources ==="
-          kubectl get paperclipinstances -A -o wide || true
+          echo "=== Instance resources ==="
+          kubectl get instances -A -o wide || true
           echo "=== Operator logs (all) ==="
           kubectl logs -n paperclip-operator-system -l control-plane=controller-manager --tail=-1 || true

.github/workflows/operatorhub.yaml

@@ -45,8 +45,8 @@ jobs:
             > "${BUNDLE_DIR}/manifests/paperclip-operator.v${VERSION}.clusterserviceversion.yaml"
 
           # Copy CRD and metadata as-is
-          cp bundle/manifests/paperclip.inc_paperclipinstances.yaml "${BUNDLE_DIR}/manifests/" 2>/dev/null || \
-            cp config/crd/bases/paperclip.inc_paperclipinstances.yaml "${BUNDLE_DIR}/manifests/"
+          cp bundle/manifests/paperclip.inc_instances.yaml "${BUNDLE_DIR}/manifests/" 2>/dev/null || \
+            cp config/crd/bases/paperclip.inc_instances.yaml "${BUNDLE_DIR}/manifests/"
           cp bundle/metadata/annotations.yaml "${BUNDLE_DIR}/metadata/"
 
           echo "Bundle prepared at ${BUNDLE_DIR}:"

CHANGELOG.md

@@ -5,7 +5,7 @@
 ### Features
 
 * Initial release of the Paperclip Kubernetes Operator
-* PaperclipInstance CRD with comprehensive configuration (image, database, auth, storage, networking, security, scaling, observability)
+* Instance CRD with comprehensive configuration (image, database, auth, storage, networking, security, scaling, observability)
 * Managed PostgreSQL mode with auto-generated credentials
 * External database support via connection string or Secret reference
 * Persistent storage with configurable PVC

CLAUDE.md

@@ -29,13 +29,13 @@ go vet ./...           # Go vet check
 ## Architecture
 
 ```
-api/v1alpha1/          -> CRD types (PaperclipInstance)
+api/v1alpha1/          -> CRD types (Instance)
 internal/controller/   -> Reconciliation logic (single controller + metrics)
 internal/resources/    -> Pure resource builder functions (StatefulSet, Service, etc.)
 config/crd/bases/      -> Generated CRD YAML (committed to git)
 charts/                -> Helm chart (CRDs as templates in templates/crds/)
 bundle/                -> OLM bundle for OperatorHub submissions
-config/samples/        -> Example PaperclipInstance CRs
+config/samples/        -> Example Instance CRs
 hack/                  -> Build/sync scripts (sync-chart-crds.sh, check-helm-rbac-sync.sh)
 .github/workflows/     -> CI/CD pipelines
 ```
@@ -137,7 +137,7 @@ git worktree remove ../paperclip-operator-<suffix>
 ```
 
 ### CRD API changes
-After modifying types in `api/v1alpha1/paperclipinstance_types.go`:
+After modifying types in `api/v1alpha1/instance_types.go`:
 1. Run `make generate` (regenerates `zz_generated.deepcopy.go`)
 2. Run `make manifests` (regenerates CRD YAML in `config/crd/bases/`)
 3. Run `make sync-chart-crds` (syncs CRDs into Helm chart templates)

CONTRIBUTING.md

@@ -109,7 +109,7 @@ Use [Conventional Commits](https://www.conventionalcommits.org/):
 
 ### CRD API Changes
 
-After modifying types in `api/v1alpha1/paperclipinstance_types.go`:
+After modifying types in `api/v1alpha1/instance_types.go`:
 1. Run `make generate` (regenerates deepcopy methods)
 2. Run `make manifests` (regenerates CRD YAML)
 3. Run `make sync-chart-crds` (syncs CRDs into Helm chart)

PROJECT

@@ -17,7 +17,7 @@ resources:
   controller: true
   domain: inc
   group: paperclip
-  kind: PaperclipInstance
+  kind: Instance
   path: github.com/stubbi/paperclip-operator/api/v1alpha1
   version: v1alpha1
 version: "3"

README.md

@@ -29,7 +29,7 @@ kubectl apply -f https://github.com/stubbi/paperclip-operator/releases/latest/do
 
 ```yaml
 apiVersion: paperclip.inc/v1alpha1
-kind: PaperclipInstance
+kind: Instance
 metadata:
   name: my-paperclip
 spec:
@@ -59,7 +59,7 @@ kubectl apply -f my-paperclip.yaml
 ### Check status
 
 ```bash
-kubectl get paperclipinstances
+kubectl get instances
 # or shorthand:
 kubectl get pci
 ```

api/v1alpha1/paperclipinstance_types.go

@@ -22,8 +22,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// PaperclipInstanceSpec defines the desired state of a Paperclip instance.
-type PaperclipInstanceSpec struct {
+// InstanceSpec defines the desired state of a Paperclip instance.
+type InstanceSpec struct {
 	// Image specifies the Paperclip container image to deploy.
 	// +optional
 	Image ImageSpec `json:"image,omitempty"`
@@ -615,27 +615,27 @@ type BackupS3Spec struct {
 
 // --- Status types ---
 
-// PaperclipInstancePhase describes the phase of a PaperclipInstance.
+// InstancePhase describes the phase of a Instance.
 // +kubebuilder:validation:Enum=Pending;Provisioning;Running;Degraded;Failed;Terminating;BackingUp;Restoring;Updating
-type PaperclipInstancePhase string
+type InstancePhase string
 
 const (
-	PhasePending      PaperclipInstancePhase = "Pending"
-	PhaseProvisioning PaperclipInstancePhase = "Provisioning"
-	PhaseRunning      PaperclipInstancePhase = "Running"
-	PhaseDegraded     PaperclipInstancePhase = "Degraded"
-	PhaseFailed       PaperclipInstancePhase = "Failed"
-	PhaseTerminating  PaperclipInstancePhase = "Terminating"
-	PhaseBackingUp    PaperclipInstancePhase = "BackingUp"
-	PhaseRestoring    PaperclipInstancePhase = "Restoring"
-	PhaseUpdating     PaperclipInstancePhase = "Updating"
+	PhasePending      InstancePhase = "Pending"
+	PhaseProvisioning InstancePhase = "Provisioning"
+	PhaseRunning      InstancePhase = "Running"
+	PhaseDegraded     InstancePhase = "Degraded"
+	PhaseFailed       InstancePhase = "Failed"
+	PhaseTerminating  InstancePhase = "Terminating"
+	PhaseBackingUp    InstancePhase = "BackingUp"
+	PhaseRestoring    InstancePhase = "Restoring"
+	PhaseUpdating     InstancePhase = "Updating"
 )
 
-// PaperclipInstanceStatus defines the observed state of PaperclipInstance.
-type PaperclipInstanceStatus struct {
+// InstanceStatus defines the observed state of Instance.
+type InstanceStatus struct {
 	// Phase is the current phase of the instance.
 	// +optional
-	Phase PaperclipInstancePhase `json:"phase,omitempty"`
+	Phase InstancePhase `json:"phase,omitempty"`
 
 	// ObservedGeneration is the most recent generation observed by the controller.
 	// +optional
@@ -715,24 +715,24 @@ type RestoreStatus struct {
 // +kubebuilder:printcolumn:name="Endpoint",type=string,JSONPath=`.status.endpoint`
 // +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
 
-// PaperclipInstance is the Schema for the paperclipinstances API.
-type PaperclipInstance struct {
+// Instance is the Schema for the instances API.
+type Instance struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   PaperclipInstanceSpec   `json:"spec,omitempty"`
-	Status PaperclipInstanceStatus `json:"status,omitempty"`
+	Spec   InstanceSpec   `json:"spec,omitempty"`
+	Status InstanceStatus `json:"status,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 
-// PaperclipInstanceList contains a list of PaperclipInstance.
-type PaperclipInstanceList struct {
+// InstanceList contains a list of Instance.
+type InstanceList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []PaperclipInstance `json:"items"`
+	Items           []Instance `json:"items"`
 }
 
 func init() {
-	SchemeBuilder.Register(&PaperclipInstance{}, &PaperclipInstanceList{})
+	SchemeBuilder.Register(&Instance{}, &InstanceList{})
 }