Merge branch 'main' into patch-1
This commit is contained in:
Joe Bowbeer
27
docs/_static/custom.css
vendored
27
docs/_static/custom.css
vendored
@@ -94,4 +94,29 @@ body {
|
||||
|
||||
.progress-0plus .progress-bar {
|
||||
background-color: #ff1744;
|
||||
}
|
||||
}
|
||||
|
||||
/* Custom admonitions */
|
||||
/* See https://squidfunk.github.io/mkdocs-material/reference/admonitions */
|
||||
:root {
|
||||
--md-admonition-icon--heart: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14 20.408c-.492.308-.903.546-1.192.709-.153.086-.308.17-.463.252h-.002a.75.75 0 0 1-.686 0 16.709 16.709 0 0 1-.465-.252 31.147 31.147 0 0 1-4.803-3.34C3.8 15.572 1 12.331 1 8.513 1 5.052 3.829 2.5 6.736 2.5 9.03 2.5 10.881 3.726 12 5.605 13.12 3.726 14.97 2.5 17.264 2.5 20.17 2.5 23 5.052 23 8.514c0 3.818-2.801 7.06-5.389 9.262A31.146 31.146 0 0 1 14 20.408z"/></svg>')
|
||||
}
|
||||
.md-typeset .admonition.heart,
|
||||
.md-typeset details.heart {
|
||||
border-color: rgb(233, 30, 99);
|
||||
}
|
||||
.md-typeset .heart > .admonition-title,
|
||||
.md-typeset .heart > summary {
|
||||
background-color: rgba(233, 30, 99, 0.1);
|
||||
}
|
||||
.md-typeset .heart > .admonition-title::before,
|
||||
.md-typeset .heart > summary::before {
|
||||
background-color: rgb(233, 30, 99);
|
||||
-webkit-mask-image: var(--md-admonition-icon--heart);
|
||||
mask-image: var(--md-admonition-icon--heart);
|
||||
}
|
||||
|
||||
.timetable-explicit-col-widths th:nth-child(1) { width: 4%; }
|
||||
.timetable-explicit-col-widths th:nth-child(2) { width: 32%; }
|
||||
.timetable-explicit-col-widths th:nth-child(3) { width: 32%; }
|
||||
.timetable-explicit-col-widths th:nth-child(4) { width: 32%; }
|
||||
|
||||
@@ -85,6 +85,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
|
||||
* [flux export](flux_export.md) - Export resources in YAML format
|
||||
* [flux get](flux_get.md) - Get sources and resources
|
||||
* [flux install](flux_install.md) - Install or upgrade Flux
|
||||
* [flux logs](flux_logs.md) - Display formatted logs for toolkit components
|
||||
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources
|
||||
* [flux resume](flux_resume.md) - Resume suspended resources
|
||||
* [flux suspend](flux_suspend.md) - Suspend resources
|
||||
|
||||
59
docs/cmd/flux_logs.md
Normal file
59
docs/cmd/flux_logs.md
Normal file
@@ -0,0 +1,59 @@
|
||||
## flux logs
|
||||
|
||||
Display formatted logs for toolkit components
|
||||
|
||||
### Synopsis
|
||||
|
||||
The logs command displays formatted logs from various toolkit components.
|
||||
|
||||
```
|
||||
flux logs [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Get logs from toolkit components
|
||||
flux logs
|
||||
|
||||
# Stream logs from toolkit components
|
||||
flux logs --follow
|
||||
|
||||
# Get logs from toolkit components in a particular namespace
|
||||
flux logs --flux-namespace my-namespace
|
||||
|
||||
# Get logs for a particular log level
|
||||
flux logs --level=info
|
||||
|
||||
# Filter logs by kind, name, or namespace
|
||||
flux logs --kind=kustomization --name podinfo --namespace default
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces displays logs for objects across all namespaces
|
||||
--flux-namespace string the namespace where the Flux components are running. (default "flux-system")
|
||||
-f, --follow Specifies if the logs should be streamed
|
||||
-h, --help help for logs
|
||||
--kind string displays errors of a particular toolkit kind e.g GitRepository
|
||||
--level logLevel log level, available options are: (debug, info, error)
|
||||
--name string specifies the name of the object logs to be displayed
|
||||
--tail int lines of recent log file to display (default -1)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--context string kubernetes context to use
|
||||
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
|
||||
-n, --namespace string the namespace scope for this operation (default "flux-system")
|
||||
--timeout duration timeout for this operation (default 5m0s)
|
||||
--verbose print generated objects
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
|
||||
|
||||
@@ -431,8 +431,8 @@ spec:
|
||||
```
|
||||
|
||||
!!! hint
|
||||
If you are using the same image repository in several manifests, you only need one
|
||||
`ImageRepository` object for it.
|
||||
If you are using the same image repository in several manifests, you only need one
|
||||
`ImageRepository` object for it.
|
||||
|
||||
##### Using image registry credentials for scanning
|
||||
|
||||
|
||||
38
docs/migration/timetable.md
Normal file
38
docs/migration/timetable.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
hide:
|
||||
# The table data on this page is easier to read when wider
|
||||
# The TOC right column is already blank anyway
|
||||
- toc
|
||||
---
|
||||
# Migration and Support Timetable
|
||||
|
||||
!!! heart "Flux Migration Commitment"
|
||||
This public timetable clarifies our commitment to end users.
|
||||
Its purpose is to help improve your experience in deciding how and when to plan infra decisions related to Flux versions.
|
||||
Please refer to the [Roadmap](../roadmap/index.md) for additional details.
|
||||
|
||||
<!-- Note: this div allows us to set fixed column widths in custom.css -->
|
||||
<!-- See: https://github.com/squidfunk/mkdocs-material/issues/118 -->
|
||||
<div markdown="1" class="timetable-explicit-col-widths">
|
||||
|
||||
<!-- Requires mkdocs markdown_extensions footnotes and pymdownx.caret -->
|
||||
<!-- markdownlint-disable-file MD033 -->
|
||||
| Date | Flux 1 | Flux 2 CLI | GOTK[^1] |
|
||||
| -- | -- | -- | -- |
|
||||
| Oct 6, 2020 | ^^[Maintenance Mode](https://github.com/fluxcd/website/pull/25)^^<br><ul><li>Flux 1 releases only include critical bug fixes (which don’t require changing Flux 1 architecture), and security patches (for OS packages, Go runtime, and kubectl). No new features</li><li>Existing projects encouraged to test migration to Flux 2 pre-releases in non-production</li></ul> | ^^Development Mode^^<br><ul><li>Working to finish parity with Flux 1</li><li>New projects encouraged to test Flux 2 pre-releases in non-production</li></ul> | ^^All Alpha^^[^2] |
|
||||
Feb 18, 2021 | ^^Partial Migration Mode^^<br><ul><li>Existing projects encouraged to migrate to `v1beta1`/`v2beta1` if you only use those features (Flux 1 read-only mode, and Helm Operator)</li><li>Existing projects encouraged to test image automation Alpha in non-production</li></ul> | ^^Feature Parity^^ | ^^Image Automation Alpha. All others reached Feature Parity, Beta^^ |
|
||||
| TBD | ^^Superseded^^<br><ul><li>All existing projects encouraged to [migrate to Flux 2](https://toolkit.fluxcd.io/guides/flux-v1-migration/), and [report any bugs](https://github.com/fluxcd/flux2/issues/new/choose)</li><li>Flux 1 Helm Operator archived – no further updates due to unsupported dependencies</li></ul> | ^^Needs further testing, may get breaking changes^^<br><ul><li>CLI needs further user testing during this migration period</li></ul> | ^^All Beta, Production Ready^^[^3]<br><ul><li>All Flux 1 features stable and supported in Flux 2</li><li>Promoting Alpha versions to Beta makes this Production Ready</li></ul> |
|
||||
| TBD | ^^Migration and security support only^^<br><ul><li>Flux 1 releases only include security patches (no bug fixes)</li><li>Maintainers support users with migration to Flux 2 only, no longer with Flux 1 issues</li><li>Flux 1 archive date announced</li></ul> | ^^Public release (GA), Production Ready^^<br><ul><li>CLI commits to backwards compatibility moving forward</li><li>CLI follows kubectl style backwards compatibility support: +1 -1 MINOR version for server components (e.g., APIs, Controllers, validation webhooks)</li></ul> | ^^All Beta, Production Ready^^ |
|
||||
| TBD | ^^Archived^^<br><ul><li>Flux 1 obsolete, no further releases or maintainer support</li><li>Flux 1 repo archived</li></ul> | ^^Continued active development^^ | ^^Continued active development^^ |
|
||||
|
||||
<!-- end .timetable-explicit-col-widths -->
|
||||
</div>
|
||||
|
||||
[^1]: GOTK is shorthand for the [GitOps Toolkit](https://toolkit.fluxcd.io/components/) APIs and Controllers
|
||||
|
||||
[^2]: Versioning: Flux 2 is a multi-service architecture, so requires a more complex explanation than Flux 1:
|
||||
- Flux 2 CLI follows [Semantic Versioning](https://semver.org/) scheme
|
||||
- The GitOps Toolkit APIs follow the [Kubernetes API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) pattern. See [Roadmap](https://toolkit.fluxcd.io/roadmap/) for component versions.
|
||||
- These are coordinated for cross-compatibility: For each Flux 2 CLI tag, CLI and GOTK versions are end-to-end tested together, so you may safely upgrade from one MINOR/PATCH version to another.
|
||||
|
||||
[^3]: The GOTK Custom Resource Definitions which are at `v1beta1` and `v2beta1` and their controllers are considered stable and production ready. Going forward, breaking changes to the beta CRDs will be accompanied by a conversion mechanism.
|
||||
@@ -4,6 +4,7 @@
|
||||
The Flux custom resource definitions which are at `v1beta1` and `v2beta1`
|
||||
and their controllers are considered stable and production ready.
|
||||
Going forward, breaking changes to the beta CRDs will be accompanied by a conversion mechanism.
|
||||
Please see the [Migration and Suport Timetable](../migration/timetable.md) for our commitment to end users.
|
||||
|
||||
The following components (included by default in [flux bootstrap](../guides/installation.md#bootstrap))
|
||||
are considered production ready:
|
||||
|
||||
Reference in New Issue
Block a user