Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add duration doc page #467

Merged
merged 4 commits into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/concepts/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
** xref:tls_server_verification.adoc[]
** xref:pod_placement.adoc[]
** xref:overrides.adoc[]
** xref:duration.adoc[]
** xref:operations/index.adoc[]
*** xref:operations/cluster_operations.adoc[]
*** xref:operations/pod_placement.adoc[]
Expand Down
27 changes: 27 additions & 0 deletions modules/concepts/pages/duration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= Duration format

:rust-duration-max: https://doc.rust-lang.org/std/time/struct.Duration.html#associatedconstant.MAX
:go-std-time: https://cs.opensource.google/go/go/+/refs/tags/go1.21.2:src/time/format.go;l=1589
:k8s-cr: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
:go: https://go.dev/

All Stackable operators use a human-readable duration format. It very closely resembles the format used by the {go}[Go] programming language - which Kubernetes uses internally.
Every duration field of a {k8s-cr}[CustomResource], for example, the xref:trino:usage-guide/operations/graceful-shutdown.adoc[`spec.workers.roleConfig.gracefulShutdownTimeout`] field, supports this format.
There is no official format specification, but the source code of {go-std-time}[`time.ParseDuration`] in the Go standard library can be used as an implementation reference.

The format looks like this: `15d18h34m42s`.
Techassi marked this conversation as resolved.
Show resolved Hide resolved
xref:trino:index.adoc[Trino], for example, uses it in the following way:

[source,yaml]
----
# ...
spec:
workers:
roleConfig:
gracefulShutdownTimeout: 15d18h34m42s
----

Valid time units are: `d`, `h`, `m`, `s`, and `ms`.
Separating the duration fragments, which is a tuple of time value and time unit (`15d`), by spaces is **not** supported and will result in an error.
The maximum amount of time which can safely be represented without precision loss or integer overflow is 584,942,417,355 years.
See {rust-duration-max}[here] for more information.