docs: Default Grafana version in CRDs + Release Artifacts in new Versioning doc (#2257)

* feat(Grafana): Add default version to manifest field description

* docs: Versioning page with some links and explanations

* feat(Make): Update versioning doc with `prep-release` target

Author: Baarsgaard

Makefile

@@ -69,6 +69,8 @@ manifests: $(CONTROLLER_GEN) $(KUSTOMIZE) $(YQ) ## Generate WebhookConfiguration
 	# Remove CRD descriptions under Grafana#.spec.deployment
 	$(YQ) -i '.spec.versions[] |= del(.schema.openAPIV3Schema.properties.spec.properties.deployment.properties | .. | select(has("description")).description)' config/crd/bases/grafana.integreatly.org_grafanas.yaml
 	$(YQ) -i '.spec.versions[] |= del(.schema.openAPIV3Schema.properties.spec.properties.deployment.properties | .. | select(has("description")).description)' deploy/helm/grafana-operator/files/crds/grafana.integreatly.org_grafanas.yaml
+	$(YQ) -i '.spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.version.description += "\ndefault: $(GRAFANA_VERSION)"' config/crd/bases/grafana.integreatly.org_grafanas.yaml
+	$(YQ) -i '.spec.versions[0].schema.openAPIV3Schema.properties.spec.properties.version.description += "\ndefault: $(GRAFANA_VERSION)"' deploy/helm/grafana-operator/files/crds/grafana.integreatly.org_grafanas.yaml
 
 	$(YQ) -i '(select(.kind == "Deployment") | .spec.template.spec.containers[0].env[] | select (.name == "RELATED_IMAGE_GRAFANA")).value="$(GRAFANA_IMAGE):$(GRAFANA_VERSION)"' config/manager/manager.yaml
 
@@ -334,5 +336,6 @@ prep-release: $(YQ)
 	$(YQ) -i '.params.version="v$(VERSION)"' hugo/config.yaml
 	sed -i 's/--version v5.*/--version v$(VERSION)/g' README.md
 	sed -i 's/^VERSION ?= 5.*/VERSION ?= $(VERSION)/g' Makefile
+	grep -q "$(GRAFANA_VERSION)" docs/docs/versioning.md || sed -Ei 's/\|-\|-\|/|-|-|\n| \`v$(VERSION)\` | \`$(GRAFANA_VERSION)\` |/' docs/docs/versioning.md
 	$(YQ) -i '.images[0].newTag="v$(VERSION)"' deploy/kustomize/base/kustomization.yaml
 	make helm-docs

api/v1beta1/grafana_types.go

@@ -73,7 +73,8 @@ type GrafanaSpec struct {
 	Route *RouteOpenshiftV1 `json:"route,omitempty"`
 	// Service sets how the service object should look like with your grafana instance, contains a number of defaults.
 	Service *ServiceV1 `json:"service,omitempty"`
-	// Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags
+	// Version sets the tag of the default image: docker.io/grafana/grafana.
+	// Allows full image refs with/without sha256checksum: "registry/repo/image:tag@sha"
 	Version string `json:"version,omitempty"`
 	// Deployment sets how the deployment object should look like with your grafana instance, contains a number of defaults.
 	Deployment *DeploymentV1 `json:"deployment,omitempty"`

config/crd/bases/grafana.integreatly.org_grafanas.yaml

@@ -5094,7 +5094,10 @@ spec:
                   description: Suspend pauses reconciliation of owned resources like deployments, Services, Etc. upon changes
                   type: boolean
                 version:
-                  description: Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags
+                  description: |-
+                    Version sets the tag of the default image: docker.io/grafana/grafana.
+                    Allows full image refs with/without sha256checksum: "registry/repo/image:tag@sha"
+                    default: 12.2.1
                   type: string
               type: object
             status:

deploy/helm/grafana-operator/files/crds/grafana.integreatly.org_grafanas.yaml

@@ -5094,7 +5094,10 @@ spec:
                   description: Suspend pauses reconciliation of owned resources like deployments, Services, Etc. upon changes
                   type: boolean
                 version:
-                  description: Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags
+                  description: |-
+                    Version sets the tag of the default image: docker.io/grafana/grafana.
+                    Allows full image refs with/without sha256checksum: "registry/repo/image:tag@sha"
+                    default: 12.2.1
                   type: string
               type: object
             status:

deploy/kustomize/base/crds.yaml

@@ -8500,9 +8500,10 @@ spec:
                   deployments, Services, Etc. upon changes
                 type: boolean
               version:
-                description: Version specifies the version of Grafana to use for this
-                  deployment. It follows the same format as the docker.io/grafana/grafana
-                  tags
+                description: |-
+                  Version sets the tag of the default image: docker.io/grafana/grafana.
+                  Allows full image refs with/without sha256checksum: "registry/repo/image:tag@sha"
+                  default: 12.2.1
                 type: string
             type: object
           status:

docs/docs/api.md

@@ -6389,7 +6389,9 @@ GrafanaSpec defines the desired state of Grafana
         <td><b>version</b></td>
         <td>string</td>
         <td>
-          Version specifies the version of Grafana to use for this deployment. It follows the same format as the docker.io/grafana/grafana tags<br/>
+          Version sets the tag of the default image: docker.io/grafana/grafana.
+Allows full image refs with/without sha256checksum: "registry/repo/image:tag@sha"
+default: 12.2.1<br/>
         </td>
         <td>false</td>
       </tr></tbody>

docs/docs/versioning.md

@@ -0,0 +1,27 @@
+---
+title: Versioning
+weight: 60
+---
+
+The Grafana version when unspecified in `Grafana#spec.version`
+
+| Operator Version | Default Grafana Image |
+|-|-|
+| `v5.20.0` | `12.2.0` |
+| `v5.19.0` | `12.1.0` |
+| `v5.16.0` | `11.3.0` |
+| `v5.9.2` | `10.4.3` |
+| `v5.7.0` | `9.5.17` |
+| `v5.0.0` | `9.1.6` |
+
+## Published Artifacts and Changelogs
+
+Changelogs are published under [Github Releases](https://github.com/grafana/grafana-operator/releases/).
+
+Previous artifacts are available under [Github Packages](https://github.com/orgs/grafana/packages?repo_name=grafana-operator).
+
+|     Type          |                        Source                        |
+| ----------------- | ---------------------------------------------------- |
+| Docker Image      | `ghcr.io/grafana/grafana-operator`                   |
+| Helm Chart        | `oci://ghcr.io/grafana/helm-charts/grafana-operator` |
+| Flux OCI Artifact | `ghcr.io/grafana/kustomize/grafana-operator`         |