You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The __[Solr Operator](https://solr.apache.org/operator/)__manages Apache Solr Clouds within Kubernetes.
26
+
The __[Solr Operator](https://solr.apache.org/operator/)__is the official way of managing an Apache Solr ecosystem within Kubernetes.
27
27
It is built on top of the [Kube Builder](https://github.com/kubernetes-sigs/kubebuilder) framework.
28
28
Please visit the [official site](https://solr.apache.org/operator/) for more information.
29
29
30
-
The project is currently in beta (`v1beta1`), and while we do not anticipate changing the API in backwards-incompatible ways there is no such guarantee yet.
30
+
The project is **Production Ready**, and has been successfully used to manage production SolrClouds for some of the largest users of Solr.
31
+
32
+
The API Version is still beta (`v1beta1`), and minor versions can have backwards-incompatible API changes.
33
+
However, the Solr Operator will always have upgrade paths that are backwards-compatible.
34
+
Please check the [version compatibility and upgrade/deprecation notes](#version-compatibility--upgrade-notes) for more information.
31
35
32
36
If you run into issues using the Solr Operator, please:
33
37
- Reference the [version compatibility and upgrade/deprecation notes](#version-compatibility--upgrade-notes) provided below
Copy file name to clipboardExpand all lines: docs/upgrade-notes.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Please carefully read the entries for all versions between the version you are r
21
21
22
22
Ensure to read the [Upgrade Warnings and Notes](#upgrade-warnings-and-notes) for the version you are upgrading to as well as the versions you are skipping.
23
23
24
-
If you want to skip versions when upgrading, be sure to check out the [upgrading minor versions](#upgrading-minor-versions-v_x_) and [upgrading patch versions](#upgrading-patch-versions-v__x) sections.
24
+
If you want to skip versions when upgrading, be sure to check out the [upgrading minor versions](#upgrading-minor-versions-vxa---vxb) and [upgrading patch versions](#upgrading-patch-versions-vxya---vzyb) sections.
25
25
26
26
## Version Compatibility Matrixes
27
27
@@ -62,17 +62,25 @@ There may be options and features that require newer versions of Solr.
62
62
Please test to make sure the features you plan to use are compatible with the version of Solr you choose to run.
63
63
64
64
65
-
### Upgrading from `v0.2.x` to `v0.3.x`
66
-
If you are upgrading from `v0.2.x` to `v0.3.x`, please follow the [Upgrading to Apache guide](upgrading-to-apache.md).
67
-
This is a special upgrade that requires different instructions.
65
+
## Upgrade Instructions
68
66
69
-
### Upgrading minor versions (`v_.X._`)
67
+
Please follow the instructions below when upgrading the Solr Operator.
68
+
69
+
However, no matter the upgrade, always read the [Upgrade Notes](#upgrade-warnings-and-notes) for every version between
70
+
71
+
### Upgrading minor versions (`vX.A._` -> `vX.B._`)
70
72
71
73
In order to upgrade minor versions (e.g. `v0.2.5` -> `v0.3.0`), you must upgrade one minor version at a time (e.g. `v0.2.0` -> `v0.3.0` -> `v0.4.0`).
72
74
It is also necessary to upgrade to the latest patch version before upgrading to the next minor version.
73
75
Therefore if you are running `v0.2.5` and you want to upgrade to `v0.3.0`, you must first upgrade to `v0.2.8` before upgrading to `v0.3.0`.
74
76
75
-
### Upgrading patch versions (`v_._.X`)
77
+
There when upgrading minor versions, there may be CRD options that have been deprecated.
78
+
The Solr Operator will automatically change the existing Solr resources to use the new format.
79
+
Therefore when upgrading to the next version, which may remove the deprecated option, the existing resources will behave correctly.
80
+
However, creating new resources with the deprecated options will fail.
81
+
Be sure to carefully read the [Upgrade Warnings](#upgrade-warnings-and-notes) to be sure you are not using deprecated options.
0 commit comments