Mirrors
/
flux2
mirror of https://github.com/fluxcd/flux2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Max Jonas Werner <makkes@users.noreply.github.com>
Co-authored-by: Aurel Canciu <aurelcanciu@gmail.com>
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
pull/3254/head
Stefan Prodan 2 years ago
parent 33fdaee399
commit 33be9840f0
No known key found for this signature in database
GPG Key ID: 3299AEB0E4085BAF
3 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File

30
docs/release/controllers.md
Unescape Escape View File

@ -2,16 +2,16 @@
The Flux controllers are The Flux controllers are
[Kubernetes operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/), [Kubernetes operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/),
each controller has its own Git repository and release cycle. each controller has its own Git repository and release cycle (see below for details).
Controller repositories and their interdependencies: Controller repositories and their interdependencies:
1. [fluxcd/source-controller](https://github.com/fluxcd/source-controller) 1. [source-controller](https://github.com/fluxcd/source-controller)
2. [fluxcd/kustomize-controller](https://github.com/fluxcd/kustomize-controller) (imports `fluxcd/source-controller/api`) 2. [kustomize-controller](https://github.com/fluxcd/kustomize-controller) (imports `fluxcd/source-controller/api`)
3. [fluxcd/helm-controller](https://github.com/fluxcd/helm-controller) (imports `fluxcd/source-controller/api`) 3. [helm-controller](https://github.com/fluxcd/helm-controller) (imports `fluxcd/source-controller/api`)
4. [fluxcd/notification-controller](https://github.com/fluxcd/notification-controller) 4. [notification-controller](https://github.com/fluxcd/notification-controller)
5. [fluxcd/image-reflector-controller](https://github.com/fluxcd/image-reflector-controller) 5. [image-reflector-controller](https://github.com/fluxcd/image-reflector-controller)
6. [fluxcd/image-automation-controller](https://github.com/fluxcd/image-automation-controller) (imports `fluxcd/source-controller/api` and `fluxcd/image-reflector-controller/api`) 6. [image-automation-controller](https://github.com/fluxcd/image-automation-controller) (imports `fluxcd/source-controller/api` and `fluxcd/image-reflector-controller/api`)
## API versioning ## API versioning
@ -23,11 +23,11 @@ The Flux APIs (Kubernetes CRDs) follow the
An alpha version API e.g. `v1alpha1` is considered experimental and should be used on An alpha version API e.g. `v1alpha1` is considered experimental and should be used on
test environments only. test environments only.
The schema of objects may change in incompatible ways in a later controller release. The schema of objects may change in incompatible ways in a later API version.
The Custom Resources may require editing and re-creating after a CRD update. The Custom Resources may require editing and re-creating after a CRD update.
An alpha version API becomes deprecated once a subsequent alpha or beta API version is released. An alpha version API becomes deprecated once a subsequent alpha or beta API version is released.
A deprecated alpha version is subject to removal after a three months period. A deprecated alpha version is subject to removal after a three month period.
An alpha API is introduced when its proposal reaches the `implementable` phase in the An alpha API is introduced when its proposal reaches the `implementable` phase in the
[Flux RFC process](https://github.com/fluxcd/flux2/tree/main/rfcs). [Flux RFC process](https://github.com/fluxcd/flux2/tree/main/rfcs).
@ -48,14 +48,14 @@ A deprecated beta version is subject to removal after a six months period.
### Stable version ### Stable version
A stable version API e.g. `v2` is considered feature complete. A stable API version, e.g. `v2`, is considered feature complete.
Any changes to the object schema do not require editing or re-creating of Custom Resources. Any changes to the object schema do not require editing or re-creating of Custom Resources.
Schema fields can't be removed, only new fields can be added with a default value that Schema fields can't be removed, only new fields can be added with a default value that
doesn't affect the controller's current behaviour. doesn't affect the controller's current behaviour.
A stable version API becomes deprecated once a subsequent stable version is released. A stable API version becomes deprecated once a subsequent stable version is released.
Stable API versions are not subject to removal in any future release of a controller major version. Stable API versions are not subject to removal in any future release within a controller major version.
In effect, this means that for as long as Flux `v2` is being maintained, all the stable API versions In effect, this means that for as long as Flux `v2` is being maintained, all the stable API versions
will be supported. will be supported.
@ -65,7 +65,7 @@ will be supported.
The Flux controllers and their Go API packages are released by following the The Flux controllers and their Go API packages are released by following the
[Go module version numbering](https://go.dev/doc/modules/version-numbers) conventions: [Go module version numbering](https://go.dev/doc/modules/version-numbers) conventions:
- `vX.Y.Z-RC.W` release candidates e.g. `v1.0.0-RC.1` - `vX.Y.Z-rc.W` release candidates e.g. `v1.0.0-rc.1`
- `vX.Y.Z` stable releases e.g. `v1.0.0` - `vX.Y.Z` stable releases e.g. `v1.0.0`
The API versioning and controller versioning are indirectly related. For example, The API versioning and controller versioning are indirectly related. For example,
@ -86,7 +86,7 @@ Patch releases are intended for critical bug fixes to the latest minor version,
vulnerabilities or fixes to severe problems with no workaround. vulnerabilities or fixes to severe problems with no workaround.
Patch releases do not contain breaking changes, feature additions or any type of user-facing changes. Patch releases do not contain breaking changes, feature additions or any type of user-facing changes.
If a CVE fix requires a breaking change, then a minor release will provide the fix. If a security fix requires a breaking change, then a minor release will provide the fix.
We expect users to be running the latest patch release of a given minor release as soon as the We expect users to be running the latest patch release of a given minor release as soon as the
controller release is included in a Flux patch release. controller release is included in a Flux patch release.
@ -119,7 +119,7 @@ and a support window of one year will be provided for the previous major version
Flux controllers are at least released at the same rate as Kubernetes, following their cadence of three Flux controllers are at least released at the same rate as Kubernetes, following their cadence of three
minor releases per year. After each Kubernetes minor release, all controllers are tested against the latest minor releases per year. After each Kubernetes minor release, all controllers are tested against the latest
Kubernetes version and are released at approximately two weeks after Kubernetes. Kubernetes version and then released approximately two weeks after Kubernetes.
The newly released controllers offer support for Kubernetes N-2 minor versions. The newly released controllers offer support for Kubernetes N-2 minor versions.
A Flux controller may have more than three minor releases per year, if maintainers decide to ship a A Flux controller may have more than three minor releases per year, if maintainers decide to ship a

10
docs/release/flux.md
Unescape Escape View File

@ -8,7 +8,7 @@ bundling the [Flux controllers](controllers.md) into a distributable package.
Flux is released by following the [semver](https://semver.org/) conventions: Flux is released by following the [semver](https://semver.org/) conventions:
- `vX.Y.Z-RC.W` release candidates e.g. `v2.0.0-rc.1` - `vX.Y.Z-rc.W` release candidates e.g. `v2.0.0-rc.1`
- `vX.Y.Z` stable releases e.g. `v2.0.0` - `vX.Y.Z` stable releases e.g. `v2.0.0`
The Flux project maintains release branches for the most recent three minor releases The Flux project maintains release branches for the most recent three minor releases
@ -36,7 +36,7 @@ We expect users to be running the latest patch release of a given minor release.
### Minor releases ### Minor releases
Minor releases are intended for backwards compatible feature additions and improvements. Minor releases are intended for backward-compatible feature additions and improvements.
Note that breaking changes may occur if required by a security vulnerability fix. Note that breaking changes may occur if required by a security vulnerability fix.
Minor releases are used when updating the Flux controllers or Kubernetes dependencies Minor releases are used when updating the Flux controllers or Kubernetes dependencies
@ -57,11 +57,11 @@ and a support window of one year will be provided for the previous major version
Flux is at least released at the same rate as Kubernetes, following their cadence of three Flux is at least released at the same rate as Kubernetes, following their cadence of three
minor releases per year. After each Kubernetes minor release, the CLI and all controllers are minor releases per year. After each Kubernetes minor release, the CLI and all controllers are
tested against the latest Kubernetes version and are released at approximately two weeks after Kubernetes. tested against the latest Kubernetes version and are released approximately two weeks after Kubernetes.
The newly released Flux version offers support for Kubernetes N-2 minor versions. The newly released Flux version offers support for Kubernetes N-2 minor versions.
Flux may have more than three minor releases per year, if maintainers decide to ship a Flux may have more than three minor releases per year if maintainers decide to ship a
new feature or optimisation ahead of schedule. new feature or optimization ahead of schedule.
## Supported releases ## Supported releases

2
docs/release/packages.md
Unescape Escape View File

@ -11,7 +11,7 @@ for projects which integrate and/or extend Flux.
The Flux packages are released by following the The Flux packages are released by following the
[Go module version numbering](https://go.dev/doc/modules/version-numbers) conventions: [Go module version numbering](https://go.dev/doc/modules/version-numbers) conventions:
- `NAME/vX.Y.Z-RC.W` release candidates e.g. `runtime/v1.0.0-RC.1` - `NAME/vX.Y.Z-rc.W` release candidates e.g. `runtime/v1.0.0-rc.1`
- `NAME/vX.Y.Z` stable releases e.g. `runtime/v1.0.0` - `NAME/vX.Y.Z` stable releases e.g. `runtime/v1.0.0`
To import or update a Flux package in a Go project: To import or update a Flux package in a Go project:

Write Preview
Loading…
Cancel
Save