Skip to content

Commit 7eb745b

Browse files
committed
Update readme and upgrade notes (#643)
1 parent b5b47b6 commit 7eb745b

2 files changed

Lines changed: 20 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,15 @@
2323
[![Docker Pulls](https://img.shields.io/docker/pulls/apache/solr-operator)](https://hub.docker.com/r/apache/solr-operator/)
2424
[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://kubernetes.slack.com/messages/solr-operator)
2525

26-
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.
2727
It is built on top of the [Kube Builder](https://github.com/kubernetes-sigs/kubebuilder) framework.
2828
Please visit the [official site](https://solr.apache.org/operator/) for more information.
2929

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.
3135

3236
If you run into issues using the Solr Operator, please:
3337
- Reference the [version compatibility and upgrade/deprecation notes](#version-compatibility--upgrade-notes) provided below

docs/upgrade-notes.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Please carefully read the entries for all versions between the version you are r
2121

2222
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.
2323

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.
2525

2626
## Version Compatibility Matrixes
2727

@@ -62,17 +62,25 @@ There may be options and features that require newer versions of Solr.
6262
Please test to make sure the features you plan to use are compatible with the version of Solr you choose to run.
6363

6464

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
6866

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._`)
7072

7173
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`).
7274
It is also necessary to upgrade to the latest patch version before upgrading to the next minor version.
7375
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`.
7476

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.
82+
83+
### Upgrading patch versions (`vX.Y.A` -> `vZ.Y.B`)
7684

7785
You should be able to upgrade from a version to any patch version with the same minor and major versions.
7886
It is always encouraged to upgrade to the latest patch version of the minor and major version you are running.

0 commit comments

Comments
 (0)