diff --git a/Cargo.lock b/Cargo.lock index 375360bd6..e78060edd 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -288,9 +288,9 @@ dependencies = [ [[package]] name = "async-signal" -version = "0.2.7" +version = "0.2.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "329972aa325176e89114919f2a80fdae4f4c040f66a370b1a1159c6c0f94e7aa" +checksum = "794f185324c2f00e771cd9f1ae8b5ac68be2ca7abb129a87afd6e86d228bc54d" dependencies = [ "async-io 2.3.3", "async-lock 3.4.0", @@ -548,9 +548,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.6" +version = "4.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a9689a29b593160de5bc4aacab7b5d54fb52231de70122626c178e6a368994c7" +checksum = "5db83dced34638ad474f39f250d7fea9598bdd239eaced1bdf45d597da0f433f" dependencies = [ "clap_builder", "clap_derive", @@ -558,9 +558,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.5.6" +version = "4.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2e5387378c84f6faa26890ebf9f0a92989f8873d4d380467bcd0d8d8620424df" +checksum = "f7e204572485eb3fbf28f871612191521df159bc3e15a9f5064c66dba3a8c05f" dependencies = [ "anstream", "anstyle", @@ -1047,8 +1047,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "531e46835a22af56d1e3b66f04844bed63158bc094a628bec1d321d9b4c44bf2" dependencies = [ "bit-set", - "regex-automata 0.4.6", - "regex-syntax 0.8.3", + "regex-automata 0.4.7", + "regex-syntax 0.8.4", ] [[package]] @@ -1431,12 +1431,12 @@ dependencies = [ [[package]] name = "http-body-util" -version = "0.1.1" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0475f8b2ac86659c21b64320d5d653f9efe42acd2a4e560073ec61a155a34f1d" +checksum = "793429d76616a256bcb62c2a2ec2bed781c8307e797e2598c50010f2bee2544f" dependencies = [ "bytes", - "futures-core", + "futures-util", "http", "http-body", "pin-project-lite", @@ -1444,9 +1444,9 @@ dependencies = [ [[package]] name = "httparse" -version = "1.8.0" +version = "1.9.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d897f394bad6a705d5f4104762e116a75639e470d80901eed05a860a95cb1904" +checksum = "9f3935c160d00ac752e09787e6e6bfc26494c2183cc922f1bc678a60d4733bc2" [[package]] name = "httpdate" @@ -1569,6 +1569,124 @@ dependencies = [ "cc", ] +[[package]] +name = "icu_collections" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db2fa452206ebee18c4b5c2274dbf1de17008e874b4dc4f0aea9d01ca79e4526" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locid" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13acbb8371917fc971be86fc8057c41a64b521c184808a698c02acc242dbf637" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_locid_transform" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01d11ac35de8e40fdeda00d9e1e9d92525f3f9d887cdd7aa81d727596788b54e" +dependencies = [ + "displaydoc", + "icu_locid", + "icu_locid_transform_data", + "icu_provider", + "tinystr", + "zerovec", +] + +[[package]] +name = "icu_locid_transform_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdc8ff3388f852bede6b579ad4e978ab004f139284d7b28715f773507b946f6e" + +[[package]] +name = "icu_normalizer" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19ce3e0da2ec68599d193c93d088142efd7f9c5d6fc9b803774855747dc6a84f" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "utf16_iter", + "utf8_iter", + "write16", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8cafbf7aa791e9b22bec55a167906f9e1215fd475cd22adfcf660e03e989516" + +[[package]] +name = "icu_properties" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1f8ac670d7422d7f76b32e17a5db556510825b29ec9154f235977c9caba61036" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locid_transform", + "icu_properties_data", + "icu_provider", + "tinystr", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67a8effbc3dd3e4ba1afa8ad918d5684b8868b3b26500753effea8d2eed19569" + +[[package]] +name = "icu_provider" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ed421c8a8ef78d3e2dbc98a973be2f3770cb42b606e3ab18d6237c4dfde68d9" +dependencies = [ + "displaydoc", + "icu_locid", + "icu_provider_macros", + "stable_deref_trait", + "tinystr", + "writeable", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_provider_macros" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ec89e9337638ecdc08744df490b221a7399bf8d164eb52a665454e60e075ad6" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.66", +] + [[package]] name = "ident_case" version = "1.0.1" @@ -1577,12 +1695,14 @@ checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" [[package]] name = "idna" -version = "0.5.0" +version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "634d9b1461af396cad843f47fdba5597a4f9e6ddd4bfb6ff5d85028c25cb12f6" +checksum = "4716a3a0933a1d01c2f72450e89596eb51dd34ef3c211ccd875acdf1f8fe47ed" dependencies = [ - "unicode-bidi", - "unicode-normalization", + "icu_normalizer", + "icu_properties", + "smallvec", + "utf8_iter", ] [[package]] @@ -1865,6 +1985,12 @@ dependencies = [ "unicode-segmentation", ] +[[package]] +name = "litemap" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "643cb0b8d4fcc284004d5fd0d67ccf61dfffadb7f75e1e71bc420f4688a3a704" + [[package]] name = "lock_api" version = "0.4.12" @@ -3109,14 +3235,14 @@ dependencies = [ [[package]] name = "regex" -version = "1.10.4" +version = "1.10.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c117dbdfde9c8308975b6a18d71f3f385c89461f7b3fb054288ecf2a2058ba4c" +checksum = "b91213439dad192326a0d7c6ee3955910425f441d7038e0d6933b0aec5c4517f" dependencies = [ "aho-corasick", "memchr", - "regex-automata 0.4.6", - "regex-syntax 0.8.3", + "regex-automata 0.4.7", + "regex-syntax 0.8.4", ] [[package]] @@ -3130,13 +3256,13 @@ dependencies = [ [[package]] name = "regex-automata" -version = "0.4.6" +version = "0.4.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "86b83b8b9847f9bf95ef68afb0b8e6cdb80f498442f5179a29fad448fcc1eaea" +checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df" dependencies = [ "aho-corasick", "memchr", - "regex-syntax 0.8.3", + "regex-syntax 0.8.4", ] [[package]] @@ -3147,9 +3273,9 @@ checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1" [[package]] name = "regex-syntax" -version = "0.8.3" +version = "0.8.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56" +checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b" [[package]] name = "reqwest" @@ -3624,6 +3750,12 @@ dependencies = [ "lock_api", ] +[[package]] +name = "stable_deref_trait" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3" + [[package]] name = "static_assertions" version = "1.1.0" @@ -3670,6 +3802,17 @@ version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160" +[[package]] +name = "synstructure" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.66", +] + [[package]] name = "tabled" version = "0.15.0" @@ -3777,20 +3920,15 @@ dependencies = [ ] [[package]] -name = "tinyvec" -version = "1.6.0" +name = "tinystr" +version = "0.7.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +checksum = "9117f5d4db391c1cf6927e7bea3db74b9a1c1add8f7eda9ffd5364f40f57b82f" dependencies = [ - "tinyvec_macros", + "displaydoc", + "zerovec", ] -[[package]] -name = "tinyvec_macros" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" - [[package]] name = "tokio" version = "1.38.0" @@ -3992,27 +4130,12 @@ dependencies = [ "version_check", ] -[[package]] -name = "unicode-bidi" -version = "0.3.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75" - [[package]] name = "unicode-ident" version = "1.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" -[[package]] -name = "unicode-normalization" -version = "0.1.23" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5" -dependencies = [ - "tinyvec", -] - [[package]] name = "unicode-segmentation" version = "1.11.0" @@ -4039,9 +4162,9 @@ checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" [[package]] name = "url" -version = "2.5.0" +version = "2.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "31e6302e3bb753d46e83516cae55ae196fc0c309407cf11ab35cc51a4c2a4633" +checksum = "f7c25da092f0a868cdf09e8674cd3b7ef3a7d92a24253e663a2fb85e2496de56" dependencies = [ "form_urlencoded", "idna", @@ -4049,11 +4172,23 @@ dependencies = [ "serde", ] +[[package]] +name = "utf16_iter" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8232dd3cdaed5356e0f716d285e4b40b932ac434100fe9b7e0e8e935b9e6246" + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + [[package]] name = "utf8parse" -version = "0.2.1" +version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" [[package]] name = "utoipa" @@ -4321,9 +4456,9 @@ dependencies = [ [[package]] name = "windows-result" -version = "0.1.1" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "749f0da9cc72d82e600d8d2e44cadd0b9eedb9038f71a1c58556ac1c5791813b" +checksum = "5e383302e8ec8515204254685643de10811af0ed97ea37210dc26fb0032647f8" dependencies = [ "windows-targets 0.52.5", ] @@ -4495,6 +4630,42 @@ dependencies = [ "windows-sys 0.48.0", ] +[[package]] +name = "write16" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1890f4022759daae28ed4fe62859b1236caebfc61ede2f63ed4e695f3f6d936" + +[[package]] +name = "writeable" +version = "0.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e9df38ee2d2c3c5948ea468a8406ff0db0b29ae1ffde1bcf20ef305bcc95c51" + +[[package]] +name = "yoke" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c5b1314b079b0930c31e3af543d8ee1757b1951ae1e1565ec704403a7240ca5" +dependencies = [ + "serde", + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "28cc31741b18cb6f1d5ff12f5b7523e3d6eb0852bbbad19d73905511d9849b95" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.66", + "synstructure", +] + [[package]] name = "zerocopy" version = "0.7.34" @@ -4515,12 +4686,55 @@ dependencies = [ "syn 2.0.66", ] +[[package]] +name = "zerofrom" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91ec111ce797d0e0784a1116d0ddcdbea84322cd79e5d5ad173daeba4f93ab55" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ea7b4a3637ea8669cedf0f1fd5c286a17f3de97b8dd5a70a6c167a1730e63a5" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.66", + "synstructure", +] + [[package]] name = "zeroize" version = "1.8.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ced3678a2879b30306d323f4542626697a464a97c0a07c9aebf7ebca65cd4dde" +[[package]] +name = "zerovec" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb2cc8827d6c0994478a15c53f374f46fbd41bea663d809b14744bc42e6b109c" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97cf56601ee5052b4417d90c8755c6683473c926039908196cf35d99f893ebe7" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.66", +] + [[package]] name = "zip" version = "1.1.4" diff --git a/bin/nanocld/specs/swagger.yaml b/bin/nanocld/specs/swagger.yaml index d65b5549f..b17302a95 100644 --- a/bin/nanocld/specs/swagger.yaml +++ b/bin/nanocld/specs/swagger.yaml @@ -4444,6 +4444,36 @@ components: minimum: 0 Spec: $ref: '#/components/schemas/Job' + LimitReq: + type: object + required: + - Burst + properties: + Burst: + type: integer + description: The burst size + minimum: 0 + Delay: + type: integer + description: The delay to wait before retrying + nullable: true + minimum: 0 + additionalProperties: false + LimitReqZone: + type: object + required: + - Size + - Rate + properties: + Size: + type: integer + description: The max size of the cache in megabytes + minimum: 0 + Rate: + type: integer + description: The max number of request per second + minimum: 0 + additionalProperties: false LocalNodeState: type: string description: |- @@ -5448,7 +5478,8 @@ components: format: date-time description: The created at date IpAddress: - $ref: '#/components/schemas/ipnet.IpNet' + type: string + description: The ip address of the node Endpoint: type: string description: Endpoint to connect to the node diff --git a/bin/nanocld/src/services/openapi.rs b/bin/nanocld/src/services/openapi.rs index e2818c9aa..3c40579b6 100644 --- a/bin/nanocld/src/services/openapi.rs +++ b/bin/nanocld/src/services/openapi.rs @@ -74,7 +74,7 @@ use nanocl_stubs::proxy::{ ResourceProxyRule, ProxyRuleHttp, ProxyHttpLocation, ProxySsl, ProxyRuleStream, StreamTarget, ProxyStreamProtocol, UriTarget, LocationTarget, HttpTarget, UrlRedirect, UpstreamTarget, ProxyRule, - UnixTarget, ProxySslConfig, + UnixTarget, ProxySslConfig, LimitReq, LimitReqZone, }; use nanocl_stubs::statefile::{ Statefile, StatefileArg, StatefileArgKind, SubState, SubStateDef, @@ -495,6 +495,8 @@ impl Modify for VersionModifier { UpstreamTarget, UnixTarget, UriTarget, + LimitReq, + LimitReqZone, // DnsRules ResourceDnsRule, DnsEntry, diff --git a/crates/nanocl_stubs/src/node.rs b/crates/nanocl_stubs/src/node.rs index 2ec55cae5..f00b25e88 100644 --- a/crates/nanocl_stubs/src/node.rs +++ b/crates/nanocl_stubs/src/node.rs @@ -12,6 +12,7 @@ pub struct Node { /// The created at date pub created_at: chrono::NaiveDateTime, /// The ip address of the node + #[cfg_attr(feature = "utoipa", schema(value_type = String))] pub ip_address: ipnet::IpNet, /// Endpoint to connect to the node pub endpoint: String, diff --git a/doc/man/nanocl-backup.md b/doc/man/nanocl-backup.md index 27356f4b3..e3f8285b9 100644 --- a/doc/man/nanocl-backup.md +++ b/doc/man/nanocl-backup.md @@ -1,26 +1,26 @@ -# NAME +--- +title: Backup +sidebar_position: 2 +--- -backup - Backup the current state +# Backup -# SYNOPSIS +## SYNOPSIS -**backup** \[**-o**\|**\--output-dir**\] \[**-y**\|**\--yes**\] -\[**-h**\|**\--help**\] +**backup** \[**-o**\|**--output-dir**\] \[**-y**\|**--yes**\] +\[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Backup the current state -# OPTIONS +## OPTIONS -**-o**, **\--output-dir**=*OUTPUT_DIR* +**-o**, **--output-dir**=*OUTPUT_DIR* +Directory where to write the backup default to the current directory -: Directory where to write the backup default to the current directory +**-y**, **--yes** +Skip confirmation -**-y**, **\--yes** - -: Skip confirmation - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-cargo-create.md b/doc/man/nanocl-cargo-create.md index 6626e69ca..a60da30fe 100644 --- a/doc/man/nanocl-cargo-create.md +++ b/doc/man/nanocl-cargo-create.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Cargo create +sidebar_position: 4 +--- -create - Create a new cargo +# Cargo create -# SYNOPSIS +## SYNOPSIS -**create** \[**-v**\|**\--volume**\] \[**-e**\|**\--env**\] -\[**-h**\|**\--help**\] \<*NAME*\> \<*IMAGE*\> +**create** \[**-v**\|**--volume**\] \[**-e**\|**--env**\] +\[**-h**\|**--help**\] \<*NAME*\> \<*IMAGE*\> -# DESCRIPTION +## DESCRIPTION Create a new cargo -# OPTIONS +## OPTIONS -**-v**, **\--volume**=*VOLUMES* +**-v**, **--volume**=*VOLUMES* +Volumes of the cargo -: Volumes of the cargo +**-e**, **--env**=*ENV* +Environment variables of the cargo -**-e**, **\--env**=*ENV* +**-h**, **--help** +Print help -: Environment variables of the cargo +\<*NAME*\> +Name of the cargo -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of the cargo - -\<*IMAGE*\> - -: Image of the cargo +\<*IMAGE*\> +Image of the cargo diff --git a/doc/man/nanocl-cargo-exec.md b/doc/man/nanocl-cargo-exec.md index 95af4c784..6d5852e11 100644 --- a/doc/man/nanocl-cargo-exec.md +++ b/doc/man/nanocl-cargo-exec.md @@ -1,51 +1,45 @@ -# NAME +--- +title: Cargo exec +sidebar_position: 5 +--- -exec - Execute a command inside a cargo +# Cargo exec -# SYNOPSIS +## SYNOPSIS -**exec** \[**-t**\|**\--tty**\] \[**\--detach-keys**\] \[**-e **\] -\[**\--privileged**\] \[**-u **\] \[**-w**\|**\--workdir**\] -\[**-h**\|**\--help**\] \<*NAME*\> \[*COMMAND*\] +**exec** \[**-t**\|**--tty**\] \[**--detach-keys**\] \[**-e **\] +\[**--privileged**\] \[**-u **\] \[**-w**\|**--workdir**\] +\[**-h**\|**--help**\] \<*NAME*\> \[*COMMAND*\] -# DESCRIPTION +## DESCRIPTION Execute a command inside a cargo -# OPTIONS +## OPTIONS -**-t**, **\--tty** +**-t**, **--tty** +Allocate a pseudo-TTY -: Allocate a pseudo-TTY +**--detach-keys**=*DETACH_KEYS* +Override the key sequence for detaching a container -**\--detach-keys**=*DETACH_KEYS* +**-e**=*ENV* +Set environment variables -: Override the key sequence for detaching a container +**--privileged** +Give extended privileges to the command -**-e**=*ENV* +**-u**=*USER* +Username or UID (format: "\\[:\\]") -: Set environment variables +**-w**, **--workdir**=*WORKING_DIR* +Working directory inside the container -**\--privileged** +**-h**, **--help** +Print help -: Give extended privileges to the command +\<*NAME*\> +Name of cargo to execute command -**-u**=*USER* - -: Username or UID (format: \"\\[:\\]\") - -**-w**, **\--workdir**=*WORKING_DIR* - -: Working directory inside the container - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of cargo to execute command - -\[*COMMAND*\] - -: Command to execute +\[*COMMAND*\] +Command to execute diff --git a/doc/man/nanocl-cargo-history.md b/doc/man/nanocl-cargo-history.md index 56035db2c..7a83301e1 100644 --- a/doc/man/nanocl-cargo-history.md +++ b/doc/man/nanocl-cargo-history.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Cargo history +sidebar_position: 6 +--- -history - List cargo history +# Cargo history -# SYNOPSIS +## SYNOPSIS -**history** \[**-h**\|**\--help**\] \<*NAME*\> +**history** \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION List cargo history -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: Name of cargo to browse history +\<*NAME*\> +Name of cargo to browse history diff --git a/doc/man/nanocl-cargo-inspect.md b/doc/man/nanocl-cargo-inspect.md index 3286617e1..e0f664309 100644 --- a/doc/man/nanocl-cargo-inspect.md +++ b/doc/man/nanocl-cargo-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Cargo inspect +sidebar_position: 7 +--- -inspect - Inspect a cargo by its name +# Cargo inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a cargo by its name -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-cargo-list.md b/doc/man/nanocl-cargo-list.md index 77257d05e..b8a8812bd 100644 --- a/doc/man/nanocl-cargo-list.md +++ b/doc/man/nanocl-cargo-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Cargo list +sidebar_position: 8 +--- -list - List existing cargo +# Cargo list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing cargo -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-cargo-logs.md b/doc/man/nanocl-cargo-logs.md index 98959408c..2591fde63 100644 --- a/doc/man/nanocl-cargo-logs.md +++ b/doc/man/nanocl-cargo-logs.md @@ -1,42 +1,38 @@ -# NAME +--- +title: Cargo logs +sidebar_position: 9 +--- -logs - Show logs +# Cargo logs -# SYNOPSIS +## SYNOPSIS -**logs** \[**-s **\] \[**-u **\] \[**-t **\] \[**\--timestamps**\] -\[**-f **\] \[**-h**\|**\--help**\] \<*NAME*\> +**logs** \[**-s **\] \[**-u **\] \[**-t **\] \[**--timestamps**\] \[**-f +**\] \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Show logs -# OPTIONS +## OPTIONS -**-s**=*SINCE* +**-s**=*SINCE* +Only include logs since unix timestamp -: Only include logs since unix timestamp +**-u**=*UNTIL* +Only include logs until unix timestamp -**-u**=*UNTIL* +**-t**=*TAIL* +If integer only return last n logs, if "all" returns all logs -: Only include logs until unix timestamp +**--timestamps** +Bool, if set include timestamp to ever log line -**-t**=*TAIL* +**-f** +Bool, if set open the log as stream -: If integer only return last n logs, if \"all\" returns all logs +**-h**, **--help** +Print help -**\--timestamps** - -: Bool, if set include timestamp to ever log line - -**-f** - -: Bool, if set open the log as stream - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of cargo to show logs +\<*NAME*\> +Name of cargo to show logs diff --git a/doc/man/nanocl-cargo-patch.md b/doc/man/nanocl-cargo-patch.md index a0c1480a9..c6abc475b 100644 --- a/doc/man/nanocl-cargo-patch.md +++ b/doc/man/nanocl-cargo-patch.md @@ -1,39 +1,36 @@ -# NAME +--- +title: Cargo patch +sidebar_position: 10 +--- -patch - Update a cargo by its name +# Cargo patch -# SYNOPSIS +## SYNOPSIS -**patch** \[**-n**\|**\--name**\] \[**-i**\|**\--image**\] -\[**-e**\|**\--env**\] \[**-v**\|**\--volume**\] \[**-h**\|**\--help**\] +**patch** \[**-n**\|**--name**\] \[**-i**\|**--image**\] +\[**-e**\|**--env**\] \[**-v**\|**--volume**\] \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Update a cargo by its name -# OPTIONS +## OPTIONS -**-n**, **\--name**=*NEW_NAME* +**-n**, **--name**=*NEW_NAME* +New name of cargo -: New name of cargo +**-i**, **--image**=*IMAGE* +New image of cargo -**-i**, **\--image**=*IMAGE* +**-e**, **--env**=*ENV* +New environment variables of cargo -: New image of cargo +**-v**, **--volume**=*VOLUMES* +New volumes of cargo -**-e**, **\--env**=*ENV* +**-h**, **--help** +Print help -: New environment variables of cargo - -**-v**, **\--volume**=*VOLUMES* - -: New volumes of cargo - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of cargo to update +\<*NAME*\> +Name of cargo to update diff --git a/doc/man/nanocl-cargo-remove.md b/doc/man/nanocl-cargo-remove.md index a049343d9..0cc24a9c0 100644 --- a/doc/man/nanocl-cargo-remove.md +++ b/doc/man/nanocl-cargo-remove.md @@ -1,30 +1,27 @@ -# NAME +--- +title: Cargo remove +sidebar_position: 11 +--- -remove - Remove cargo by its name +# Cargo remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-f**\|**\--force**\] -\[**-h**\|**\--help**\] \[*KEYS*\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-f**\|**--force**\] +\[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove cargo by its name -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-f**, **--force** -**-f**, **\--force** +**-h**, **--help** +Print help -: - -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-cargo-restart.md b/doc/man/nanocl-cargo-restart.md index 2d81cf935..888ba8963 100644 --- a/doc/man/nanocl-cargo-restart.md +++ b/doc/man/nanocl-cargo-restart.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Cargo restart +sidebar_position: 12 +--- -restart - Restart a cargo by its name +# Cargo restart -# SYNOPSIS +## SYNOPSIS -**restart** \[**-h**\|**\--help**\] \[*NAMES*\] +**restart** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Restart a cargo by its name -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-cargo-revert.md b/doc/man/nanocl-cargo-revert.md index 946b3060c..26e994985 100644 --- a/doc/man/nanocl-cargo-revert.md +++ b/doc/man/nanocl-cargo-revert.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Cargo revert +sidebar_position: 13 +--- -revert - Revert cargo to a specific history +# Cargo revert -# SYNOPSIS +## SYNOPSIS -**revert** \[**-h**\|**\--help**\] \<*NAME*\> \<*HISTORY_ID*\> +**revert** \[**-h**\|**--help**\] \<*NAME*\> \<*HISTORY_ID*\> -# DESCRIPTION +## DESCRIPTION Revert cargo to a specific history -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help +\<*NAME*\> +Name of cargo to revert -\<*NAME*\> - -: Name of cargo to revert - -\<*HISTORY_ID*\> - -: Revert to a specific historic +\<*HISTORY_ID*\> +Revert to a specific historic diff --git a/doc/man/nanocl-cargo-run.md b/doc/man/nanocl-cargo-run.md index 1e802b59c..294703d8c 100644 --- a/doc/man/nanocl-cargo-run.md +++ b/doc/man/nanocl-cargo-run.md @@ -1,42 +1,37 @@ -# NAME +--- +title: Cargo run +sidebar_position: 14 +--- -run - Run a cargo +# Cargo run -# SYNOPSIS +## SYNOPSIS -**run** \[**-v**\|**\--volume**\] \[**-e**\|**\--env**\] \[**\--rm**\] -\[**-h**\|**\--help**\] \<*NAME*\> \<*IMAGE*\> \[*COMMAND*\] +**run** \[**-v**\|**--volume**\] \[**-e**\|**--env**\] \[**--rm**\] +\[**-h**\|**--help**\] \<*NAME*\> \<*IMAGE*\> \[*COMMAND*\] -# DESCRIPTION +## DESCRIPTION Run a cargo -# OPTIONS +## OPTIONS -**-v**, **\--volume**=*VOLUMES* +**-v**, **--volume**=*VOLUMES* +Volumes of the cargo -: Volumes of the cargo +**-e**, **--env**=*ENV* +Environment variables of the cargo -**-e**, **\--env**=*ENV* +**--rm** -: Environment variables of the cargo +**-h**, **--help** +Print help -**\--rm** +\<*NAME*\> +Name of the cargo -: +\<*IMAGE*\> +Image of the cargo -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of the cargo - -\<*IMAGE*\> - -: Image of the cargo - -\[*COMMAND*\] - -: Command to execute +\[*COMMAND*\] +Command to execute diff --git a/doc/man/nanocl-cargo-start.md b/doc/man/nanocl-cargo-start.md index 99b0a1377..0fa7cc7bc 100644 --- a/doc/man/nanocl-cargo-start.md +++ b/doc/man/nanocl-cargo-start.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Cargo start +sidebar_position: 15 +--- -start - Start cargoes by names +# Cargo start -# SYNOPSIS +## SYNOPSIS -**start** \[**-h**\|**\--help**\] \[*NAMES*\] +**start** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Start cargoes by names -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-cargo-stats.md b/doc/man/nanocl-cargo-stats.md index 75b2bba90..264ebde54 100644 --- a/doc/man/nanocl-cargo-stats.md +++ b/doc/man/nanocl-cargo-stats.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Cargo stats +sidebar_position: 16 +--- -stats - Show stats of cargo +# Cargo stats -# SYNOPSIS +## SYNOPSIS -**stats** \[**\--no-stream**\] \[**-h**\|**\--help**\] \[*NAMES*\] +**stats** \[**--no-stream**\] \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Show stats of cargo -# OPTIONS +## OPTIONS -**\--no-stream** +**--no-stream** +Disable streaming stats and only pull the first result -: Disable streaming stats and only pull the first result +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*NAMES*\] - -: Names of cargo to show stats +\[*NAMES*\] +Names of cargo to show stats diff --git a/doc/man/nanocl-cargo-stop.md b/doc/man/nanocl-cargo-stop.md index d9aae313c..da8cfb222 100644 --- a/doc/man/nanocl-cargo-stop.md +++ b/doc/man/nanocl-cargo-stop.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Cargo stop +sidebar_position: 17 +--- -stop - Stop cargoes by names +# Cargo stop -# SYNOPSIS +## SYNOPSIS -**stop** \[**-h**\|**\--help**\] \[*NAMES*\] +**stop** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Stop cargoes by names -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-cargo.md b/doc/man/nanocl-cargo.md index 50fda758f..1f8fbb976 100644 --- a/doc/man/nanocl-cargo.md +++ b/doc/man/nanocl-cargo.md @@ -1,84 +1,70 @@ -# NAME +--- +title: Cargo +sidebar_position: 3 +--- -cargo - Manage cargoes +# Cargo -# SYNOPSIS +## SYNOPSIS -**cargo** \[**-n**\|**\--namespace**\] \[**-h**\|**\--help**\] +**cargo** \[**-n**\|**--namespace**\] \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage cargoes -# OPTIONS +## OPTIONS -**-n**, **\--namespace**=*NAMESPACE* +**-n**, **--namespace**=*NAMESPACE* +namespace to target by default global is used -: namespace to target by default global is used - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -cargo-list(1) - -: List existing cargo - -cargo-create(1) - -: Create a new cargo - -cargo-start(1) - -: Start cargoes by names - -cargo-stop(1) - -: Stop cargoes by names - -cargo-restart(1) - -: Restart a cargo by its name - -cargo-remove(1) - -: Remove cargo by its name - -cargo-inspect(1) - -: Inspect a cargo by its name - -cargo-patch(1) - -: Update a cargo by its name +cargo-list(1) +List existing cargo -cargo-exec(1) +cargo-create(1) +Create a new cargo -: Execute a command inside a cargo +cargo-start(1) +Start cargoes by names -cargo-history(1) +cargo-stop(1) +Stop cargoes by names -: List cargo history +cargo-restart(1) +Restart a cargo by its name -cargo-revert(1) +cargo-remove(1) +Remove cargo by its name -: Revert cargo to a specific history +cargo-inspect(1) +Inspect a cargo by its name -cargo-logs(1) +cargo-patch(1) +Update a cargo by its name -: Show logs +cargo-exec(1) +Execute a command inside a cargo -cargo-run(1) +cargo-history(1) +List cargo history -: Run a cargo +cargo-revert(1) +Revert cargo to a specific history -cargo-stats(1) +cargo-logs(1) +Show logs -: Show stats of cargo +cargo-run(1) +Run a cargo -cargo-help(1) +cargo-stats(1) +Show stats of cargo -: Print this message or the help of the given subcommand(s) +cargo-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-context-from.md b/doc/man/nanocl-context-from.md index 0f78c617d..88ac314e4 100644 --- a/doc/man/nanocl-context-from.md +++ b/doc/man/nanocl-context-from.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Context from +sidebar_position: 19 +--- -from - Create a new context from a file +# Context from -# SYNOPSIS +## SYNOPSIS -**from** \[**-h**\|**\--help**\] \<*PATH*\> +**from** \[**-h**\|**--help**\] \<*PATH*\> -# DESCRIPTION +## DESCRIPTION Create a new context from a file -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*PATH*\> - -: Path to context file +\<*PATH*\> +Path to context file diff --git a/doc/man/nanocl-context-list.md b/doc/man/nanocl-context-list.md index cfec91ae4..11253ef04 100644 --- a/doc/man/nanocl-context-list.md +++ b/doc/man/nanocl-context-list.md @@ -1,17 +1,19 @@ -# NAME +--- +title: Context list +sidebar_position: 20 +--- -list - List contexts +# Context list -# SYNOPSIS +## SYNOPSIS -**list** \[**-h**\|**\--help**\] +**list** \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List contexts -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-context-use.md b/doc/man/nanocl-context-use.md index 582de5ba0..f70ea9668 100644 --- a/doc/man/nanocl-context-use.md +++ b/doc/man/nanocl-context-use.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Context use +sidebar_position: 21 +--- -use - Set current context +# Context use -# SYNOPSIS +## SYNOPSIS -**use** \[**-h**\|**\--help**\] \<*NAME*\> +**use** \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Set current context -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: Context name +\<*NAME*\> +Context name diff --git a/doc/man/nanocl-context.md b/doc/man/nanocl-context.md index 45aecadb4..8db802adc 100644 --- a/doc/man/nanocl-context.md +++ b/doc/man/nanocl-context.md @@ -1,35 +1,33 @@ -# NAME +--- +title: Context +sidebar_position: 18 +--- -context - Manage contexts +# Context -# SYNOPSIS +## SYNOPSIS -**context** \[**-h**\|**\--help**\] \<*subcommands*\> +**context** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage contexts -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -context-list(1) - -: List contexts - -context-use(1) - -: Set current context - -context-from(1) +context-list(1) +List contexts -: Create a new context from a file +context-use(1) +Set current context -context-help(1) +context-from(1) +Create a new context from a file -: Print this message or the help of the given subcommand(s) +context-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-event-inspect.md b/doc/man/nanocl-event-inspect.md index 9bbbd6226..81dfec0ef 100644 --- a/doc/man/nanocl-event-inspect.md +++ b/doc/man/nanocl-event-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Event inspect +sidebar_position: 23 +--- -inspect - Inspect a specific event +# Event inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a specific event -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-event-list.md b/doc/man/nanocl-event-list.md index 2a5c1df20..bcaeff1b2 100644 --- a/doc/man/nanocl-event-list.md +++ b/doc/man/nanocl-event-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Event list +sidebar_position: 24 +--- -list - List existing events +# Event list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing events -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-event-watch.md b/doc/man/nanocl-event-watch.md index 2110bfd38..f2aed4c03 100644 --- a/doc/man/nanocl-event-watch.md +++ b/doc/man/nanocl-event-watch.md @@ -1,17 +1,19 @@ -# NAME +--- +title: Event watch +sidebar_position: 25 +--- -watch - Watch for new events in real time +# Event watch -# SYNOPSIS +## SYNOPSIS -**watch** \[**-h**\|**\--help**\] +**watch** \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Watch for new events in real time -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-event.md b/doc/man/nanocl-event.md index 410968cda..c9d8cce60 100644 --- a/doc/man/nanocl-event.md +++ b/doc/man/nanocl-event.md @@ -1,35 +1,33 @@ -# NAME +--- +title: Event +sidebar_position: 22 +--- -event - Show or watch events +# Event -# SYNOPSIS +## SYNOPSIS -**event** \[**-h**\|**\--help**\] \<*subcommands*\> +**event** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Show or watch events -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -event-list(1) - -: List existing events - -event-watch(1) - -: Watch for new events in real time - -event-inspect(1) +event-list(1) +List existing events -: Inspect a specific event +event-watch(1) +Watch for new events in real time -event-help(1) +event-inspect(1) +Inspect a specific event -: Print this message or the help of the given subcommand(s) +event-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-info.md b/doc/man/nanocl-info.md index 77cfd877a..f653a6167 100644 --- a/doc/man/nanocl-info.md +++ b/doc/man/nanocl-info.md @@ -1,17 +1,19 @@ -# NAME +--- +title: Info +sidebar_position: 26 +--- -info - Show nanocl host information +# Info -# SYNOPSIS +## SYNOPSIS -**info** \[**-h**\|**\--help**\] +**info** \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Show nanocl host information -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-install.md b/doc/man/nanocl-install.md index dbe00cf85..4cff951da 100644 --- a/doc/man/nanocl-install.md +++ b/doc/man/nanocl-install.md @@ -1,73 +1,62 @@ -# NAME +--- +title: Install +sidebar_position: 27 +--- -install - Install components +# Install -# SYNOPSIS +## SYNOPSIS -**install** \[**\--docker-host**\] \[**\--docker-desktop**\] -\[**\--state-dir**\] \[**\--conf-dir**\] \[**\--gateway**\] -\[**\--advertise-addr**\] \[**\--daemon-hosts**\] \[**\--group**\] -\[**\--hostname**\] \[**-t**\|**\--template**\] -\[**-p**\|**\--force-pull**\] \[**-f **\] \[**-h**\|**\--help**\] +**install** \[**--docker-host**\] \[**--docker-desktop**\] +\[**--state-dir**\] \[**--conf-dir**\] \[**--gateway**\] +\[**--advertise-addr**\] \[**--daemon-hosts**\] \[**--group**\] +\[**--hostname**\] \[**-t**\|**--template**\] +\[**-p**\|**--force-pull**\] \[**-f **\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Install components -# OPTIONS +## OPTIONS -**\--docker-host**=*DOCKER_HOST* +**--docker-host**=*DOCKER_HOST* +The docker host to install nanocl default is unix:///var/run/docker.sock -: The docker host to install nanocl default is - unix:///var/run/docker.sock +**--docker-desktop** +Specify if the docker host is docker desktop detected if docker context +is desktop-linux -**\--docker-desktop** +**--state-dir**=*STATE_DIR* +The state directory to store the state of the nanocl daemon default is +/var/lib/nanocl -: Specify if the docker host is docker desktop detected if docker - context is desktop-linux +**--conf-dir**=*CONF_DIR* +The configuration directory to store the configuration of the nanocl +daemon default is /etc/nanocl -**\--state-dir**=*STATE_DIR* +**--gateway**=*GATEWAY* +The gateway address to use for the nanocl daemon default is detected -: The state directory to store the state of the nanocl daemon default - is /var/lib/nanocl +**--advertise-addr**=*ADVERTISE_ADDR* +The hosts to use for the nanocl daemon default is detected -**\--conf-dir**=*CONF_DIR* +**--daemon-hosts**=*DAEMON_HOSTS* +The hosts to use for the nanocl daemon default is detected -: The configuration directory to store the configuration of the nanocl - daemon default is /etc/nanocl +**--group**=*GROUP* +The group to use for the nanocl daemon default is nanocl -**\--gateway**=*GATEWAY* +**--hostname**=*HOSTNAME* +The hostname to use for the nanocl daemon default is detected -: The gateway address to use for the nanocl daemon default is detected +**-t**, **--template**=*TEMPLATE* +Installation template to use for nanocl by default its detected -**\--advertise-addr**=*ADVERTISE_ADDR* +**-p**, **--force-pull** +Force re pull of the nanocl components -: The hosts to use for the nanocl daemon default is detected +**-f** +Attach to the container logs after installation -**\--daemon-hosts**=*DAEMON_HOSTS* - -: The hosts to use for the nanocl daemon default is detected - -**\--group**=*GROUP* - -: The group to use for the nanocl daemon default is nanocl - -**\--hostname**=*HOSTNAME* - -: The hostname to use for the nanocl daemon default is detected - -**-t**, **\--template**=*TEMPLATE* - -: Installation template to use for nanocl by default its detected - -**-p**, **\--force-pull** - -: Force re pull of the nanocl components - -**-f** - -: Attach to the container logs after installation - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-job-inspect.md b/doc/man/nanocl-job-inspect.md index 65db9c5ff..00ccead3e 100644 --- a/doc/man/nanocl-job-inspect.md +++ b/doc/man/nanocl-job-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Job inspect +sidebar_position: 29 +--- -inspect - Inspect a job by its name +# Job inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a job by its name -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-job-list.md b/doc/man/nanocl-job-list.md index f1e3650e6..d5c747c69 100644 --- a/doc/man/nanocl-job-list.md +++ b/doc/man/nanocl-job-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Job list +sidebar_position: 30 +--- -list - List existing job +# Job list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing job -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-job-logs.md b/doc/man/nanocl-job-logs.md index e1553bf98..bef724ba2 100644 --- a/doc/man/nanocl-job-logs.md +++ b/doc/man/nanocl-job-logs.md @@ -1,42 +1,38 @@ -# NAME +--- +title: Job logs +sidebar_position: 31 +--- -logs - Show logs of a job +# Job logs -# SYNOPSIS +## SYNOPSIS -**logs** \[**-s **\] \[**-u **\] \[**-t **\] \[**\--timestamps**\] -\[**-f **\] \[**-h**\|**\--help**\] \<*NAME*\> +**logs** \[**-s **\] \[**-u **\] \[**-t **\] \[**--timestamps**\] \[**-f +**\] \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Show logs of a job -# OPTIONS +## OPTIONS -**-s**=*SINCE* +**-s**=*SINCE* +Only include logs since unix timestamp -: Only include logs since unix timestamp +**-u**=*UNTIL* +Only include logs until unix timestamp -**-u**=*UNTIL* +**-t**=*TAIL* +If integer only return last n logs, if "all" returns all logs -: Only include logs until unix timestamp +**--timestamps** +Bool, if set include timestamp to ever log line -**-t**=*TAIL* +**-f** +Bool, if set open the log as stream -: If integer only return last n logs, if \"all\" returns all logs +**-h**, **--help** +Print help -**\--timestamps** - -: Bool, if set include timestamp to ever log line - -**-f** - -: Bool, if set open the log as stream - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of job to show logs +\<*NAME*\> +Name of job to show logs diff --git a/doc/man/nanocl-job-remove.md b/doc/man/nanocl-job-remove.md index f45403d67..eb2b105e2 100644 --- a/doc/man/nanocl-job-remove.md +++ b/doc/man/nanocl-job-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Job remove +sidebar_position: 32 +--- -remove - Remove job by its name +# Job remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove job by its name -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-job-start.md b/doc/man/nanocl-job-start.md index e27a54a54..9dd2a44ea 100644 --- a/doc/man/nanocl-job-start.md +++ b/doc/man/nanocl-job-start.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Job start +sidebar_position: 33 +--- -start - Start a job +# Job start -# SYNOPSIS +## SYNOPSIS -**start** \[**-h**\|**\--help**\] \[*NAMES*\] +**start** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Start a job -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-job-wait.md b/doc/man/nanocl-job-wait.md index d8ce4ac31..5c1c44e23 100644 --- a/doc/man/nanocl-job-wait.md +++ b/doc/man/nanocl-job-wait.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Job wait +sidebar_position: 34 +--- -wait - Wait for a job to finish +# Job wait -# SYNOPSIS +## SYNOPSIS -**wait** \[**-c **\] \[**-h**\|**\--help**\] \<*NAME*\> +**wait** \[**-c **\] \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Wait for a job to finish -# OPTIONS +## OPTIONS -**-c**=*CONDITION* +**-c**=*CONDITION* +State to wait -: State to wait +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of job to wait +\<*NAME*\> +Name of job to wait diff --git a/doc/man/nanocl-job.md b/doc/man/nanocl-job.md index af44fcb33..196b22c59 100644 --- a/doc/man/nanocl-job.md +++ b/doc/man/nanocl-job.md @@ -1,47 +1,42 @@ -# NAME +--- +title: Job +sidebar_position: 28 +--- -job - Manage jobs +# Job -# SYNOPSIS +## SYNOPSIS -**job** \[**-h**\|**\--help**\] \<*subcommands*\> +**job** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage jobs -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -job-list(1) - -: List existing job - -job-remove(1) - -: Remove job by its name - -job-inspect(1) - -: Inspect a job by its name - -job-logs(1) - -: Show logs of a job +job-list(1) +List existing job -job-wait(1) +job-remove(1) +Remove job by its name -: Wait for a job to finish +job-inspect(1) +Inspect a job by its name -job-start(1) +job-logs(1) +Show logs of a job -: Start a job +job-wait(1) +Wait for a job to finish -job-help(1) +job-start(1) +Start a job -: Print this message or the help of the given subcommand(s) +job-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-metric-inspect.md b/doc/man/nanocl-metric-inspect.md index 7840eb686..8db8f2a42 100644 --- a/doc/man/nanocl-metric-inspect.md +++ b/doc/man/nanocl-metric-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Metric inspect +sidebar_position: 36 +--- -inspect - Inspect a metric +# Metric inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a metric -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-metric-list.md b/doc/man/nanocl-metric-list.md index e7d9034ad..88a2c7aa9 100644 --- a/doc/man/nanocl-metric-list.md +++ b/doc/man/nanocl-metric-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Metric list +sidebar_position: 37 +--- -list - List existing metrics +# Metric list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing metrics -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-metric.md b/doc/man/nanocl-metric.md index 62a3ce32d..a06fd9ee3 100644 --- a/doc/man/nanocl-metric.md +++ b/doc/man/nanocl-metric.md @@ -1,31 +1,30 @@ -# NAME +--- +title: Metric +sidebar_position: 35 +--- -metric - Manage metrics +# Metric -# SYNOPSIS +## SYNOPSIS -**metric** \[**-h**\|**\--help**\] \<*subcommands*\> +**metric** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage metrics -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -metric-list(1) - -: List existing metrics - -metric-inspect(1) - -: Inspect a metric +metric-list(1) +List existing metrics -metric-help(1) +metric-inspect(1) +Inspect a metric -: Print this message or the help of the given subcommand(s) +metric-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-namespace-create.md b/doc/man/nanocl-namespace-create.md index 10c32e755..667506790 100644 --- a/doc/man/nanocl-namespace-create.md +++ b/doc/man/nanocl-namespace-create.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Namespace create +sidebar_position: 39 +--- -create - Create new namespace +# Namespace create -# SYNOPSIS +## SYNOPSIS -**create** \[**-h**\|**\--help**\] \<*NAME*\> +**create** \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Create new namespace -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: name of the namespace to create +\<*NAME*\> +name of the namespace to create diff --git a/doc/man/nanocl-namespace-inspect.md b/doc/man/nanocl-namespace-inspect.md index f1e0f99eb..8fb4b49aa 100644 --- a/doc/man/nanocl-namespace-inspect.md +++ b/doc/man/nanocl-namespace-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Namespace inspect +sidebar_position: 40 +--- -inspect - Inspect a namespace +# Namespace inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a namespace -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-namespace-list.md b/doc/man/nanocl-namespace-list.md index 396915d3c..45448a18a 100644 --- a/doc/man/nanocl-namespace-list.md +++ b/doc/man/nanocl-namespace-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Namespace list +sidebar_position: 41 +--- -list - List existing namespaces +# Namespace list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing namespaces -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-namespace-remove.md b/doc/man/nanocl-namespace-remove.md index cf22b22bf..311e8cabc 100644 --- a/doc/man/nanocl-namespace-remove.md +++ b/doc/man/nanocl-namespace-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Namespace remove +sidebar_position: 42 +--- -remove - Remove a namespace +# Namespace remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove a namespace -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-namespace.md b/doc/man/nanocl-namespace.md index 28790b9bd..a5e683e56 100644 --- a/doc/man/nanocl-namespace.md +++ b/doc/man/nanocl-namespace.md @@ -1,39 +1,36 @@ -# NAME +--- +title: Namespace +sidebar_position: 38 +--- -namespace - Manage namespaces +# Namespace -# SYNOPSIS +## SYNOPSIS -**namespace** \[**-h**\|**\--help**\] \<*subcommands*\> +**namespace** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage namespaces -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -namespace-create(1) - -: Create new namespace - -namespace-inspect(1) - -: Inspect a namespace - -namespace-remove(1) - -: Remove a namespace +namespace-create(1) +Create new namespace -namespace-list(1) +namespace-inspect(1) +Inspect a namespace -: List existing namespaces +namespace-remove(1) +Remove a namespace -namespace-help(1) +namespace-list(1) +List existing namespaces -: Print this message or the help of the given subcommand(s) +namespace-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-node-list.md b/doc/man/nanocl-node-list.md index 965b5df1a..b6209fe9e 100644 --- a/doc/man/nanocl-node-list.md +++ b/doc/man/nanocl-node-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Node list +sidebar_position: 44 +--- -list - List nodes +# Node list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List nodes -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-node.md b/doc/man/nanocl-node.md index 699e60174..5b430f84c 100644 --- a/doc/man/nanocl-node.md +++ b/doc/man/nanocl-node.md @@ -1,27 +1,27 @@ -# NAME +--- +title: Node +sidebar_position: 43 +--- -node - Manage nodes (experimental) +# Node -# SYNOPSIS +## SYNOPSIS -**node** \[**-h**\|**\--help**\] \<*subcommands*\> +**node** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage nodes (experimental) -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -node-list(1) - -: List nodes - -node-help(1) +node-list(1) +List nodes -: Print this message or the help of the given subcommand(s) +node-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-ps.md b/doc/man/nanocl-ps.md index 62924b80e..8f268ca48 100644 --- a/doc/man/nanocl-ps.md +++ b/doc/man/nanocl-ps.md @@ -1,48 +1,41 @@ -# NAME +--- +title: Ps +sidebar_position: 45 +--- -ps - Show processes +# Ps -# SYNOPSIS +## SYNOPSIS -**ps** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] -\[**-n**\|**\--namespace**\] \[**-k**\|**\--kind**\] -\[**-a**\|**\--all**\] \[**-h**\|**\--help**\] +**ps** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-n**\|**--namespace**\] +\[**-k**\|**--kind**\] \[**-a**\|**--all**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Show processes -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* +**-n**, **--namespace**=*NAMESPACE* +Show all processes for the given namespace -: Offset the results to navigate through the results +**-k**, **--kind**=*KIND* +Show all processes for the given kind -**\--filters**=*FILTERS* +**-a**, **--all** -: Filters - -**-n**, **\--namespace**=*NAMESPACE* - -: Show all processes for the given namespace - -**-k**, **\--kind**=*KIND* - -: Show all processes for the given kind - -**-a**, **\--all** - -: - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-resource-history.md b/doc/man/nanocl-resource-history.md index ec268c3f2..a8ed004cd 100644 --- a/doc/man/nanocl-resource-history.md +++ b/doc/man/nanocl-resource-history.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Resource history +sidebar_position: 47 +--- -history - Browse history of a resource +# Resource history -# SYNOPSIS +## SYNOPSIS -**history** \[**-h**\|**\--help**\] \<*NAME*\> +**history** \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Browse history of a resource -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: The name of the resource to browse history +\<*NAME*\> +The name of the resource to browse history diff --git a/doc/man/nanocl-resource-inspect.md b/doc/man/nanocl-resource-inspect.md index 067d8e071..2b136b45b 100644 --- a/doc/man/nanocl-resource-inspect.md +++ b/doc/man/nanocl-resource-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Resource inspect +sidebar_position: 48 +--- -inspect - Inspect a resource +# Resource inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a resource -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-resource-list.md b/doc/man/nanocl-resource-list.md index 396915d3c..ff3f6c589 100644 --- a/doc/man/nanocl-resource-list.md +++ b/doc/man/nanocl-resource-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Resource list +sidebar_position: 49 +--- -list - List existing namespaces +# Resource list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing namespaces -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-resource-remove.md b/doc/man/nanocl-resource-remove.md index edb176d73..b0bb2b125 100644 --- a/doc/man/nanocl-resource-remove.md +++ b/doc/man/nanocl-resource-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Resource remove +sidebar_position: 50 +--- -remove - Remove existing resource +# Resource remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove existing resource -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-resource-revert.md b/doc/man/nanocl-resource-revert.md index ae14bf4b3..82892071a 100644 --- a/doc/man/nanocl-resource-revert.md +++ b/doc/man/nanocl-resource-revert.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Resource revert +sidebar_position: 51 +--- -revert - Revert a resource to a specific history +# Resource revert -# SYNOPSIS +## SYNOPSIS -**revert** \[**-h**\|**\--help**\] \<*NAME*\> \<*KEY*\> +**revert** \[**-h**\|**--help**\] \<*NAME*\> \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Revert a resource to a specific history -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help +\<*NAME*\> +The name of the resource to revert -\<*NAME*\> - -: The name of the resource to revert - -\<*KEY*\> - -: The key of the history to revert to +\<*KEY*\> +The key of the history to revert to diff --git a/doc/man/nanocl-resource.md b/doc/man/nanocl-resource.md index 78cfc2a31..8e4b48ce7 100644 --- a/doc/man/nanocl-resource.md +++ b/doc/man/nanocl-resource.md @@ -1,43 +1,39 @@ -# NAME +--- +title: Resource +sidebar_position: 46 +--- -resource - Manage resources +# Resource -# SYNOPSIS +## SYNOPSIS -**resource** \[**-h**\|**\--help**\] \<*subcommands*\> +**resource** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage resources -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -resource-remove(1) - -: Remove existing resource - -resource-list(1) - -: List existing namespaces - -resource-inspect(1) - -: Inspect a resource - -resource-history(1) +resource-remove(1) +Remove existing resource -: Browse history of a resource +resource-list(1) +List existing namespaces -resource-revert(1) +resource-inspect(1) +Inspect a resource -: Revert a resource to a specific history +resource-history(1) +Browse history of a resource -resource-help(1) +resource-revert(1) +Revert a resource to a specific history -: Print this message or the help of the given subcommand(s) +resource-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-secret-create-container-registry.md b/doc/man/nanocl-secret-create-container-registry.md index 08b87a598..5e9c06b80 100644 --- a/doc/man/nanocl-secret-create-container-registry.md +++ b/doc/man/nanocl-secret-create-container-registry.md @@ -1,47 +1,35 @@ -# NAME +--- +title: Secret create container registry +sidebar_position: 54 +--- -container-registry - Create a new nanocl.io/container-registry secret +# Secret create container registry -# SYNOPSIS +## SYNOPSIS -**container-registry** \[**-h**\|**\--help**\] \[*USERNAME*\] +**container-registry** \[**-h**\|**--help**\] \[*USERNAME*\] \[*PASSWORD*\] \[*AUTH*\] \[*EMAIL*\] \[*SERVERADDRESS*\] \[*IDENTITYTOKEN*\] \[*REGISTRYTOKEN*\] -# DESCRIPTION +## DESCRIPTION Create a new nanocl.io/container-registry secret -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help +\[*USERNAME*\] -\[*USERNAME*\] +\[*PASSWORD*\] -: +\[*AUTH*\] -\[*PASSWORD*\] +\[*EMAIL*\] -: +\[*SERVERADDRESS*\] -\[*AUTH*\] +\[*IDENTITYTOKEN*\] -: - -\[*EMAIL*\] - -: - -\[*SERVERADDRESS*\] - -: - -\[*IDENTITYTOKEN*\] - -: - -\[*REGISTRYTOKEN*\] - -: +\[*REGISTRYTOKEN*\] diff --git a/doc/man/nanocl-secret-create-env.md b/doc/man/nanocl-secret-create-env.md index 04e25f926..f1533c175 100644 --- a/doc/man/nanocl-secret-create-env.md +++ b/doc/man/nanocl-secret-create-env.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Secret create env +sidebar_position: 55 +--- -env - Create a new nanocl.io/env secret +# Secret create env -# SYNOPSIS +## SYNOPSIS -**env** \[**-h**\|**\--help**\] \<*VALUES*\> +**env** \[**-h**\|**--help**\] \<*VALUES*\> -# DESCRIPTION +## DESCRIPTION Create a new nanocl.io/env secret -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*VALUES*\> - -: List of values in the form of \`key=value\` +\<*VALUES*\> +List of values in the form of \`key=value\` diff --git a/doc/man/nanocl-secret-create-tls.md b/doc/man/nanocl-secret-create-tls.md index 265f64c23..c24476c59 100644 --- a/doc/man/nanocl-secret-create-tls.md +++ b/doc/man/nanocl-secret-create-tls.md @@ -1,39 +1,36 @@ -# NAME +--- +title: Secret create tls +sidebar_position: 56 +--- -tls - Create a new nanocl.io/tls secret +# Secret create tls -# SYNOPSIS +## SYNOPSIS -**tls** \<**\--certificate**\> \<**\--certificate-key**\> -\[**\--certificate-client**\] \[**\--dhparam**\] -\[**\--verify-client**\] \[**-h**\|**\--help**\] +**tls** \<**--certificate**\> \<**--certificate-key**\> +\[**--certificate-client**\] \[**--dhparam**\] \[**--verify-client**\] +\[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Create a new nanocl.io/tls secret -# OPTIONS +## OPTIONS -**\--certificate**=*CERTIFICATE* +**--certificate**=*CERTIFICATE* +Certificate -: Certificate +**--certificate-key**=*CERTIFICATE_KEY* +Certificate key -**\--certificate-key**=*CERTIFICATE_KEY* +**--certificate-client**=*CERTIFICATE_CLIENT* +Client certificate -: Certificate key +**--dhparam**=*DHPARAM* +DHParam -**\--certificate-client**=*CERTIFICATE_CLIENT* +**--verify-client** +Verify client -: Client certificate - -**\--dhparam**=*DHPARAM* - -: DHParam - -**\--verify-client** - -: Verify client - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-secret-create.md b/doc/man/nanocl-secret-create.md index 2db317b9d..98da105f2 100644 --- a/doc/man/nanocl-secret-create.md +++ b/doc/man/nanocl-secret-create.md @@ -1,39 +1,36 @@ -# NAME +--- +title: Secret create +sidebar_position: 53 +--- -create - Create a new secret +# Secret create -# SYNOPSIS +## SYNOPSIS -**create** \[**-h**\|**\--help**\] \<*NAME*\> \<*subcommands*\> +**create** \[**-h**\|**--help**\] \<*NAME*\> \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Create a new secret -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: Name of your secret +\<*NAME*\> +Name of your secret # SUBCOMMANDS -create-env(1) - -: Create a new nanocl.io/env secret - -create-tls(1) - -: Create a new nanocl.io/tls secret - -create-container-registry(1) +create-env(1) +Create a new nanocl.io/env secret -: Create a new nanocl.io/container-registry secret +create-tls(1) +Create a new nanocl.io/tls secret -create-help(1) +create-container-registry(1) +Create a new nanocl.io/container-registry secret -: Print this message or the help of the given subcommand(s) +create-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-secret-inspect.md b/doc/man/nanocl-secret-inspect.md index 98dfc3237..8de2248c4 100644 --- a/doc/man/nanocl-secret-inspect.md +++ b/doc/man/nanocl-secret-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Secret inspect +sidebar_position: 57 +--- -inspect - Inspect a secret +# Secret inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a secret -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-secret-list.md b/doc/man/nanocl-secret-list.md index 3b1622290..737bd17b6 100644 --- a/doc/man/nanocl-secret-list.md +++ b/doc/man/nanocl-secret-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Secret list +sidebar_position: 58 +--- -list - List existing secret +# Secret list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List existing secret -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-secret-remove.md b/doc/man/nanocl-secret-remove.md index 57ddc3c42..a812fa30f 100644 --- a/doc/man/nanocl-secret-remove.md +++ b/doc/man/nanocl-secret-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Secret remove +sidebar_position: 59 +--- -remove - Remove existing secret +# Secret remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove existing secret -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-secret.md b/doc/man/nanocl-secret.md index c314fc7d2..97b36a19b 100644 --- a/doc/man/nanocl-secret.md +++ b/doc/man/nanocl-secret.md @@ -1,39 +1,36 @@ -# NAME +--- +title: Secret +sidebar_position: 52 +--- -secret - Manage secrets +# Secret -# SYNOPSIS +## SYNOPSIS -**secret** \[**-h**\|**\--help**\] \<*subcommands*\> +**secret** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage secrets -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -secret-remove(1) - -: Remove existing secret - -secret-list(1) - -: List existing secret - -secret-inspect(1) - -: Inspect a secret +secret-remove(1) +Remove existing secret -secret-create(1) +secret-list(1) +List existing secret -: Create a new secret +secret-inspect(1) +Inspect a secret -secret-help(1) +secret-create(1) +Create a new secret -: Print this message or the help of the given subcommand(s) +secret-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-state-apply.md b/doc/man/nanocl-state-apply.md index 7753cceb7..0520086f5 100644 --- a/doc/man/nanocl-state-apply.md +++ b/doc/man/nanocl-state-apply.md @@ -1,43 +1,39 @@ -# NAME +--- +title: State apply +sidebar_position: 61 +--- -apply - Create or Update elements from a Statefile +# State apply -# SYNOPSIS +## SYNOPSIS -**apply** \[**-s**\|**\--state-location**\] \[**-f**\|**\--follow**\] -\[**-y**\|**\--yes**\] \[**-r**\|**\--reload**\] -\[**\--remove-orphans**\] \[**-h**\|**\--help**\] \[*ARGS*\] +**apply** \[**-s**\|**--state-location**\] \[**-f**\|**--follow**\] +\[**-y**\|**--yes**\] \[**-r**\|**--reload**\] \[**--remove-orphans**\] +\[**-h**\|**--help**\] \[*ARGS*\] -# DESCRIPTION +## DESCRIPTION Create or Update elements from a Statefile -# OPTIONS +## OPTIONS -**-s**, **\--state-location**=*STATE_LOCATION* +**-s**, **--state-location**=*STATE_LOCATION* +Path or Url to the Statefile -: Path or Url to the Statefile +**-f**, **--follow** +Follow logs of the deployed cargo -**-f**, **\--follow** +**-y**, **--yes** +Skip the confirmation prompt -: Follow logs of the deployed cargo +**-r**, **--reload** +Perform an apply even if state didnt changed -**-y**, **\--yes** +**--remove-orphans** +Remove orphaned elements -: Skip the confirmation prompt +**-h**, **--help** +Print help -**-r**, **\--reload** - -: Perform an apply even if state didnt changed - -**\--remove-orphans** - -: Remove orphaned elements - -**-h**, **\--help** - -: Print help - -\[*ARGS*\] - -: Additional arguments to pass to the file +\[*ARGS*\] +Additional arguments to pass to the file diff --git a/doc/man/nanocl-state-logs.md b/doc/man/nanocl-state-logs.md index baf409021..56a17eef3 100644 --- a/doc/man/nanocl-state-logs.md +++ b/doc/man/nanocl-state-logs.md @@ -1,47 +1,42 @@ -# NAME +--- +title: State logs +sidebar_position: 62 +--- -logs - Logs elements from a Statefile +# State logs -# SYNOPSIS +## SYNOPSIS -**logs** \[**-s**\|**\--state-location**\] \[**\--since**\] \[**-u **\] -\[**-t **\] \[**\--timestamps**\] \[**-f **\] \[**-h**\|**\--help**\] +**logs** \[**-s**\|**--state-location**\] \[**--since**\] \[**-u **\] +\[**-t **\] \[**--timestamps**\] \[**-f **\] \[**-h**\|**--help**\] \[*ARGS*\] -# DESCRIPTION +## DESCRIPTION Logs elements from a Statefile -# OPTIONS +## OPTIONS -**-s**, **\--state-location**=*STATE_LOCATION* +**-s**, **--state-location**=*STATE_LOCATION* +Path or Url to the Statefile -: Path or Url to the Statefile +**--since**=*SINCE* +Only include logs since unix timestamp -**\--since**=*SINCE* +**-u**=*UNTIL* +Only include logs until unix timestamp -: Only include logs since unix timestamp +**-t**=*TAIL* +If integer only return last n logs, if "all" returns all logs -**-u**=*UNTIL* +**--timestamps** +Bool, if set include timestamp to ever log line -: Only include logs until unix timestamp +**-f** +Bool, if set open the log as stream -**-t**=*TAIL* +**-h**, **--help** +Print help -: If integer only return last n logs, if \"all\" returns all logs - -**\--timestamps** - -: Bool, if set include timestamp to ever log line - -**-f** - -: Bool, if set open the log as stream - -**-h**, **\--help** - -: Print help - -\[*ARGS*\] - -: Additional arguments to pass to the file +\[*ARGS*\] +Additional arguments to pass to the file diff --git a/doc/man/nanocl-state-remove.md b/doc/man/nanocl-state-remove.md index 9bcda975b..f474c50d4 100644 --- a/doc/man/nanocl-state-remove.md +++ b/doc/man/nanocl-state-remove.md @@ -1,30 +1,29 @@ -# NAME +--- +title: State remove +sidebar_position: 63 +--- -remove - Remove elements from a Statefile +# State remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-s**\|**\--state-location**\] \[**-y**\|**\--yes**\] -\[**-h**\|**\--help**\] \[*ARGS*\] +**remove** \[**-s**\|**--state-location**\] \[**-y**\|**--yes**\] +\[**-h**\|**--help**\] \[*ARGS*\] -# DESCRIPTION +## DESCRIPTION Remove elements from a Statefile -# OPTIONS +## OPTIONS -**-s**, **\--state-location**=*STATE_LOCATION* +**-s**, **--state-location**=*STATE_LOCATION* +Path or Url to the Statefile -: Path or Url to the Statefile +**-y**, **--yes** +Skip the confirmation prompt -**-y**, **\--yes** +**-h**, **--help** +Print help -: Skip the confirmation prompt - -**-h**, **\--help** - -: Print help - -\[*ARGS*\] - -: Additional arguments to pass to the file +\[*ARGS*\] +Additional arguments to pass to the file diff --git a/doc/man/nanocl-state.md b/doc/man/nanocl-state.md index f0fdfbf97..26945733f 100644 --- a/doc/man/nanocl-state.md +++ b/doc/man/nanocl-state.md @@ -1,35 +1,33 @@ -# NAME +--- +title: State +sidebar_position: 60 +--- -state - Apply or Remove a Statefile +# State -# SYNOPSIS +## SYNOPSIS -**state** \[**-h**\|**\--help**\] \<*subcommands*\> +**state** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Apply or Remove a Statefile -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -state-apply(1) - -: Create or Update elements from a Statefile - -state-logs(1) - -: Logs elements from a Statefile - -state-remove(1) +state-apply(1) +Create or Update elements from a Statefile -: Remove elements from a Statefile +state-logs(1) +Logs elements from a Statefile -state-help(1) +state-remove(1) +Remove elements from a Statefile -: Print this message or the help of the given subcommand(s) +state-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-uninstall.md b/doc/man/nanocl-uninstall.md index a54f84991..8a9493285 100644 --- a/doc/man/nanocl-uninstall.md +++ b/doc/man/nanocl-uninstall.md @@ -1,32 +1,31 @@ -# NAME +--- +title: Uninstall +sidebar_position: 64 +--- -uninstall - Uninstall components +# Uninstall -# SYNOPSIS +## SYNOPSIS -**uninstall** \[**\--docker-host**\] \[**-t**\|**\--template**\] -\[**\--docker-desktop**\] \[**-h**\|**\--help**\] +**uninstall** \[**--docker-host**\] \[**-t**\|**--template**\] +\[**--docker-desktop**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Uninstall components -# OPTIONS +## OPTIONS -**\--docker-host**=*DOCKER_HOST* +**--docker-host**=*DOCKER_HOST* +The docker host where nanocl is installed default is +unix:///var/run/docker.sock -: The docker host where nanocl is installed default is - unix:///var/run/docker.sock +**-t**, **--template**=*TEMPLATE* +Uninstall template to use for nanocl by default its detected -**-t**, **\--template**=*TEMPLATE* +**--docker-desktop** +Specify if the docker host is docker desktop detected if docker context +is desktop-linux -: Uninstall template to use for nanocl by default its detected - -**\--docker-desktop** - -: Specify if the docker host is docker desktop detected if docker - context is desktop-linux - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-version.md b/doc/man/nanocl-version.md index 120d1ceca..80afdb17b 100644 --- a/doc/man/nanocl-version.md +++ b/doc/man/nanocl-version.md @@ -1,17 +1,19 @@ -# NAME +--- +title: Version +sidebar_position: 65 +--- -version - Show nanocl version information +# Version -# SYNOPSIS +## SYNOPSIS -**version** \[**-h**\|**\--help**\] +**version** \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION Show nanocl version information -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-vm-attach.md b/doc/man/nanocl-vm-attach.md index 84e065094..73353ab90 100644 --- a/doc/man/nanocl-vm-attach.md +++ b/doc/man/nanocl-vm-attach.md @@ -1,21 +1,22 @@ -# NAME +--- +title: Vm attach +sidebar_position: 67 +--- -attach - Attach to a vm +# Vm attach -# SYNOPSIS +## SYNOPSIS -**attach** \[**-h**\|**\--help**\] \<*NAME*\> +**attach** \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Attach to a vm -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\<*NAME*\> - -: Name of the vm +\<*NAME*\> +Name of the vm diff --git a/doc/man/nanocl-vm-create.md b/doc/man/nanocl-vm-create.md index dd45269ad..469156e19 100644 --- a/doc/man/nanocl-vm-create.md +++ b/doc/man/nanocl-vm-create.md @@ -1,60 +1,51 @@ -# NAME +--- +title: Vm create +sidebar_position: 68 +--- -create - Create a vm +# Vm create -# SYNOPSIS +## SYNOPSIS -**create** \[**\--hostname**\] \[**\--cpu**\] \[**\--mem**\] -\[**\--net-iface**\] \[**\--user**\] \[**\--password**\] -\[**\--ssh-key**\] \[**\--kvm**\] \[**-h**\|**\--help**\] \<*NAME*\> -\<*IMAGE*\> +**create** \[**--hostname**\] \[**--cpu**\] \[**--mem**\] +\[**--net-iface**\] \[**--user**\] \[**--password**\] \[**--ssh-key**\] +\[**--kvm**\] \[**-h**\|**--help**\] \<*NAME*\> \<*IMAGE*\> -# DESCRIPTION +## DESCRIPTION Create a vm -# OPTIONS +## OPTIONS -**\--hostname**=*HOSTNAME* +**--hostname**=*HOSTNAME* +hostname of the vm -: hostname of the vm +**--cpu**=*CPU* +Cpu of the vm default to 1 -**\--cpu**=*CPU* +**--mem**=*MEMORY* +Memory of the vm in MB default to 512 -: Cpu of the vm default to 1 +**--net-iface**=*NET_IFACE* +network interface of the vm -**\--mem**=*MEMORY* +**--user**=*USER* +Default user of the VM -: Memory of the vm in MB default to 512 +**--password**=*PASSWORD* +Default password of the VM -**\--net-iface**=*NET_IFACE* +**--ssh-key**=*SSH_KEY* +Ssh key for the user -: network interface of the vm +**--kvm** +Enable KVM -**\--user**=*USER* +**-h**, **--help** +Print help -: Default user of the VM +\<*NAME*\> +Name of the vm -**\--password**=*PASSWORD* - -: Default password of the VM - -**\--ssh-key**=*SSH_KEY* - -: Ssh key for the user - -**\--kvm** - -: Enable KVM - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of the vm - -\<*IMAGE*\> - -: Name of the vm image +\<*IMAGE*\> +Name of the vm image diff --git a/doc/man/nanocl-vm-image-clone.md b/doc/man/nanocl-vm-image-clone.md index 5fabdf491..0c23e1087 100644 --- a/doc/man/nanocl-vm-image-clone.md +++ b/doc/man/nanocl-vm-image-clone.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Vm image clone +sidebar_position: 70 +--- -clone - Clone a VM image +# Vm image clone -# SYNOPSIS +## SYNOPSIS -**clone** \[**-h**\|**\--help**\] \<*NAME*\> \<*CLONE_NAME*\> +**clone** \[**-h**\|**--help**\] \<*NAME*\> \<*CLONE_NAME*\> -# DESCRIPTION +## DESCRIPTION Clone a VM image -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help +\<*NAME*\> +Name of the VM image -\<*NAME*\> - -: Name of the VM image - -\<*CLONE_NAME*\> - -: Name of the cloned VM image +\<*CLONE_NAME*\> +Name of the cloned VM image diff --git a/doc/man/nanocl-vm-image-create.md b/doc/man/nanocl-vm-image-create.md index 544a997f1..02e70fcb1 100644 --- a/doc/man/nanocl-vm-image-create.md +++ b/doc/man/nanocl-vm-image-create.md @@ -1,25 +1,25 @@ -# NAME +--- +title: Vm image create +sidebar_position: 71 +--- -create - Create a base VM image +# Vm image create -# SYNOPSIS +## SYNOPSIS -**create** \[**-h**\|**\--help**\] \<*NAME*\> \<*FILE_PATH*\> +**create** \[**-h**\|**--help**\] \<*NAME*\> \<*FILE_PATH*\> -# DESCRIPTION +## DESCRIPTION Create a base VM image -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help +\<*NAME*\> +Name of the VM image -\<*NAME*\> - -: Name of the VM image - -\<*FILE_PATH*\> - -: Path or url to the VM image +\<*FILE_PATH*\> +Path or url to the VM image diff --git a/doc/man/nanocl-vm-image-list.md b/doc/man/nanocl-vm-image-list.md index e38c2b782..67b6023ac 100644 --- a/doc/man/nanocl-vm-image-list.md +++ b/doc/man/nanocl-vm-image-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Vm image list +sidebar_position: 72 +--- -list - List VM images +# Vm image list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List VM images -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-vm-image-remove.md b/doc/man/nanocl-vm-image-remove.md index 34b842bf2..22c632fe1 100644 --- a/doc/man/nanocl-vm-image-remove.md +++ b/doc/man/nanocl-vm-image-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Vm image remove +sidebar_position: 73 +--- -remove - Remove a VM image +# Vm image remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove a VM image -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-vm-image-resize.md b/doc/man/nanocl-vm-image-resize.md index 52e371ba0..7beb9859a 100644 --- a/doc/man/nanocl-vm-image-resize.md +++ b/doc/man/nanocl-vm-image-resize.md @@ -1,30 +1,28 @@ -# NAME +--- +title: Vm image resize +sidebar_position: 74 +--- -resize - Resize a VM image +# Vm image resize -# SYNOPSIS +## SYNOPSIS -**resize** \[**\--shrink**\] \[**-h**\|**\--help**\] \<*NAME*\> -\<*SIZE*\> +**resize** \[**--shrink**\] \[**-h**\|**--help**\] \<*NAME*\> \<*SIZE*\> -# DESCRIPTION +## DESCRIPTION Resize a VM image -# OPTIONS +## OPTIONS -**\--shrink** +**--shrink** +Shrink the image -: Shrink the image +**-h**, **--help** +Print help -**-h**, **\--help** +\<*NAME*\> +Name of the VM image -: Print help - -\<*NAME*\> - -: Name of the VM image - -\<*SIZE*\> - -: New size of the VM image +\<*SIZE*\> +New size of the VM image diff --git a/doc/man/nanocl-vm-image.md b/doc/man/nanocl-vm-image.md index 581479e9b..c5f61511b 100644 --- a/doc/man/nanocl-vm-image.md +++ b/doc/man/nanocl-vm-image.md @@ -1,43 +1,39 @@ -# NAME +--- +title: Vm image +sidebar_position: 69 +--- -image - Manage vm images +# Vm image -# SYNOPSIS +## SYNOPSIS -**image** \[**-h**\|**\--help**\] \<*subcommands*\> +**image** \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage vm images -# OPTIONS +## OPTIONS -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -image-create(1) - -: Create a base VM image - -image-clone(1) - -: Clone a VM image - -image-resize(1) - -: Resize a VM image - -image-list(1) +image-create(1) +Create a base VM image -: List VM images +image-clone(1) +Clone a VM image -image-remove(1) +image-resize(1) +Resize a VM image -: Remove a VM image +image-list(1) +List VM images -image-help(1) +image-remove(1) +Remove a VM image -: Print this message or the help of the given subcommand(s) +image-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl-vm-inspect.md b/doc/man/nanocl-vm-inspect.md index 49fc14be8..aee3e641d 100644 --- a/doc/man/nanocl-vm-inspect.md +++ b/doc/man/nanocl-vm-inspect.md @@ -1,28 +1,28 @@ -# NAME +--- +title: Vm inspect +sidebar_position: 75 +--- -inspect - Inspect a vm +# Vm inspect -# SYNOPSIS +## SYNOPSIS -**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\> +**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\> -# DESCRIPTION +## DESCRIPTION Inspect a vm -# OPTIONS +## OPTIONS -**\--display**=*DISPLAY* +**--display**=*DISPLAY* +Display format -: Display format\ - -\ + \[*possible values: *yaml, toml, json\] -**-h**, **\--help** - -: Print help - -\<*KEY*\> +**-h**, **--help** +Print help -: Key or Name of the object to inspect +\<*KEY*\> +Key or Name of the object to inspect diff --git a/doc/man/nanocl-vm-list.md b/doc/man/nanocl-vm-list.md index fd7ecefb5..2def3c6cb 100644 --- a/doc/man/nanocl-vm-list.md +++ b/doc/man/nanocl-vm-list.md @@ -1,34 +1,32 @@ -# NAME +--- +title: Vm list +sidebar_position: 76 +--- -list - List vms +# Vm list -# SYNOPSIS +## SYNOPSIS -**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\] -\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\] +**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\] +\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\] -# DESCRIPTION +## DESCRIPTION List vms -# OPTIONS +## OPTIONS -**-q**, **\--quiet** +**-q**, **--quiet** +Only show keys -: Only show keys +**-l**, **--limit**=*LIMIT* +Limit the number of results default to 100 -**-l**, **\--limit**=*LIMIT* +**-o**, **--offset**=*OFFSET* +Offset the results to navigate through the results -: Limit the number of results default to 100 +**--filters**=*FILTERS* +Filters -**-o**, **\--offset**=*OFFSET* - -: Offset the results to navigate through the results - -**\--filters**=*FILTERS* - -: Filters - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help diff --git a/doc/man/nanocl-vm-patch.md b/doc/man/nanocl-vm-patch.md index a980eb978..7a1d1ad02 100644 --- a/doc/man/nanocl-vm-patch.md +++ b/doc/man/nanocl-vm-patch.md @@ -1,55 +1,48 @@ -# NAME +--- +title: Vm patch +sidebar_position: 77 +--- -patch - Patch a vm +# Vm patch -# SYNOPSIS +## SYNOPSIS -**patch** \[**\--user**\] \[**\--password**\] \[**\--ssh-key**\] -\[**\--hostname**\] \[**\--cpu**\] \[**\--mem**\] \[**\--kvm**\] -\[**\--net-iface**\] \[**-h**\|**\--help**\] \<*NAME*\> +**patch** \[**--user**\] \[**--password**\] \[**--ssh-key**\] +\[**--hostname**\] \[**--cpu**\] \[**--mem**\] \[**--kvm**\] +\[**--net-iface**\] \[**-h**\|**--help**\] \<*NAME*\> -# DESCRIPTION +## DESCRIPTION Patch a vm -# OPTIONS +## OPTIONS -**\--user**=*USER* +**--user**=*USER* +Default user of the VM -: Default user of the VM +**--password**=*PASSWORD* +Default password of the VM -**\--password**=*PASSWORD* +**--ssh-key**=*SSH_KEY* +Ssh key for the user -: Default password of the VM +**--hostname**=*HOSTNAME* +hostname of the vm -**\--ssh-key**=*SSH_KEY* +**--cpu**=*CPU* +Cpu of the vm default to 1 -: Ssh key for the user +**--mem**=*MEMORY* +Memory of the vm in MB default to 512 -**\--hostname**=*HOSTNAME* +**--kvm** +Enable KVM -: hostname of the vm +**--net-iface**=*NET_IFACE* +network interface of the vm -**\--cpu**=*CPU* +**-h**, **--help** +Print help -: Cpu of the vm default to 1 - -**\--mem**=*MEMORY* - -: Memory of the vm in MB default to 512 - -**\--kvm** - -: Enable KVM - -**\--net-iface**=*NET_IFACE* - -: network interface of the vm - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of the vm +\<*NAME*\> +Name of the vm diff --git a/doc/man/nanocl-vm-remove.md b/doc/man/nanocl-vm-remove.md index 6ae3df6fe..3775dc094 100644 --- a/doc/man/nanocl-vm-remove.md +++ b/doc/man/nanocl-vm-remove.md @@ -1,26 +1,25 @@ -# NAME +--- +title: Vm remove +sidebar_position: 78 +--- -remove - Remove vms +# Vm remove -# SYNOPSIS +## SYNOPSIS -**remove** \[**-y**\|**\--skip-confirm**\] \[**-h**\|**\--help**\] +**remove** \[**-y**\|**--skip-confirm**\] \[**-h**\|**--help**\] \[*KEYS*\] -# DESCRIPTION +## DESCRIPTION Remove vms -# OPTIONS +## OPTIONS -**-y**, **\--skip-confirm** +**-y**, **--skip-confirm** -: +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -\[*KEYS*\] - -: The keys or names of the objects to remove +\[*KEYS*\] +The keys or names of the objects to remove diff --git a/doc/man/nanocl-vm-run.md b/doc/man/nanocl-vm-run.md index e2b5f6db0..c3db6f4d7 100644 --- a/doc/man/nanocl-vm-run.md +++ b/doc/man/nanocl-vm-run.md @@ -1,68 +1,58 @@ -# NAME +--- +title: Vm run +sidebar_position: 79 +--- -run - Run a vm +# Vm run -# SYNOPSIS +## SYNOPSIS -**run** \[**\--hostname**\] \[**\--cpu**\] \[**\--mem**\] -\[**\--net-iface**\] \[**\--user**\] \[**\--password**\] -\[**\--ssh-key**\] \[**\--img-size**\] \[**\--kvm**\] -\[**-a**\|**\--attach**\] \[**-h**\|**\--help**\] \<*NAME*\> \<*IMAGE*\> +**run** \[**--hostname**\] \[**--cpu**\] \[**--mem**\] +\[**--net-iface**\] \[**--user**\] \[**--password**\] \[**--ssh-key**\] +\[**--img-size**\] \[**--kvm**\] \[**-a**\|**--attach**\] +\[**-h**\|**--help**\] \<*NAME*\> \<*IMAGE*\> -# DESCRIPTION +## DESCRIPTION Run a vm -# OPTIONS +## OPTIONS -**\--hostname**=*HOSTNAME* +**--hostname**=*HOSTNAME* +hostname of the vm -: hostname of the vm +**--cpu**=*CPU* +Cpu of the vm default to 1 -**\--cpu**=*CPU* +**--mem**=*MEMORY* +Memory of the vm in MB default to 512 -: Cpu of the vm default to 1 +**--net-iface**=*NET_IFACE* +network interface of the vm -**\--mem**=*MEMORY* +**--user**=*USER* +Default user of the VM -: Memory of the vm in MB default to 512 +**--password**=*PASSWORD* +Default password of the VM -**\--net-iface**=*NET_IFACE* +**--ssh-key**=*SSH_KEY* +Ssh key for the user -: network interface of the vm +**--img-size**=*IMAGE_SIZE* +Size of the disk in GB -**\--user**=*USER* +**--kvm** +Enable KVM -: Default user of the VM +**-a**, **--attach** +Attach to the vm -**\--password**=*PASSWORD* +**-h**, **--help** +Print help -: Default password of the VM +\<*NAME*\> +Name of the vm -**\--ssh-key**=*SSH_KEY* - -: Ssh key for the user - -**\--img-size**=*IMAGE_SIZE* - -: Size of the disk in GB - -**\--kvm** - -: Enable KVM - -**-a**, **\--attach** - -: Attach to the vm - -**-h**, **\--help** - -: Print help - -\<*NAME*\> - -: Name of the vm - -\<*IMAGE*\> - -: Name of the vm image +\<*IMAGE*\> +Name of the vm image diff --git a/doc/man/nanocl-vm-start.md b/doc/man/nanocl-vm-start.md index c18cf1052..d94965f73 100644 --- a/doc/man/nanocl-vm-start.md +++ b/doc/man/nanocl-vm-start.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Vm start +sidebar_position: 80 +--- -start - Start a vm +# Vm start -# SYNOPSIS +## SYNOPSIS -**start** \[**-h**\|**\--help**\] \[*NAMES*\] +**start** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Start a vm -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-vm-stop.md b/doc/man/nanocl-vm-stop.md index 338c9b415..310013b26 100644 --- a/doc/man/nanocl-vm-stop.md +++ b/doc/man/nanocl-vm-stop.md @@ -1,21 +1,21 @@ -# NAME +--- +title: Vm stop +sidebar_position: 81 +--- -stop - Stop a vm +# Vm stop -# SYNOPSIS +## SYNOPSIS -**stop** \[**-h**\|**\--help**\] \[*NAMES*\] +**stop** \[**-h**\|**--help**\] \[*NAMES*\] -# DESCRIPTION +## DESCRIPTION Stop a vm -# OPTIONS +## OPTIONS -**-h**, **\--help** +**-h**, **--help** +Print help -: Print help - -\[*NAMES*\] - -: +\[*NAMES*\] diff --git a/doc/man/nanocl-vm.md b/doc/man/nanocl-vm.md index 4c9500598..b451df4e3 100644 --- a/doc/man/nanocl-vm.md +++ b/doc/man/nanocl-vm.md @@ -1,68 +1,58 @@ -# NAME +--- +title: Vm +sidebar_position: 66 +--- -vm - Manage virtual machines +# Vm -# SYNOPSIS +## SYNOPSIS -**vm** \[**-n**\|**\--namespace**\] \[**-h**\|**\--help**\] +**vm** \[**-n**\|**--namespace**\] \[**-h**\|**--help**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION Manage virtual machines -# OPTIONS +## OPTIONS -**-n**, **\--namespace**=*NAMESPACE* +**-n**, **--namespace**=*NAMESPACE* +namespace to target by default global is used -: namespace to target by default global is used - -**-h**, **\--help** - -: Print help +**-h**, **--help** +Print help # SUBCOMMANDS -vm-run(1) - -: Run a vm - -vm-image(1) - -: Manage vm images - -vm-create(1) - -: Create a vm - -vm-list(1) - -: List vms - -vm-remove(1) - -: Remove vms - -vm-inspect(1) - -: Inspect a vm +vm-run(1) +Run a vm -vm-start(1) +vm-image(1) +Manage vm images -: Start a vm +vm-create(1) +Create a vm -vm-stop(1) +vm-list(1) +List vms -: Stop a vm +vm-remove(1) +Remove vms -vm-attach(1) +vm-inspect(1) +Inspect a vm -: Attach to a vm +vm-start(1) +Start a vm -vm-patch(1) +vm-stop(1) +Stop a vm -: Patch a vm +vm-attach(1) +Attach to a vm -vm-help(1) +vm-patch(1) +Patch a vm -: Print this message or the help of the given subcommand(s) +vm-help(1) +Print this message or the help of the given subcommand(s) diff --git a/doc/man/nanocl.md b/doc/man/nanocl.md index cf111bd3c..6394b2311 100644 --- a/doc/man/nanocl.md +++ b/doc/man/nanocl.md @@ -1,103 +1,85 @@ -# NAME +--- +title: Nanocl +sidebar_position: 1 +--- -nanocl - The Self-Sufficient Orchestrator CLI +# Nanocl -# SYNOPSIS +## SYNOPSIS -**nanocl** \[**-H**\|**\--host**\] \[**-h**\|**\--help**\] -\[**-V**\|**\--version**\] \<*subcommands*\> +**nanocl** \[**-H**\|**--host**\] \[**-h**\|**--help**\] +\[**-V**\|**--version**\] \<*subcommands*\> -# DESCRIPTION +## DESCRIPTION The Self-Sufficient Orchestrator CLI -# OPTIONS +## OPTIONS -**-H**, **\--host**=*HOST* +**-H**, **--host**=*HOST* +Nanocld host default: unix://run/nanocl/nanocl.sock -: Nanocld host default: unix://run/nanocl/nanocl.sock +**-h**, **--help** +Print help -**-h**, **\--help** - -: Print help - -**-V**, **\--version** - -: Print version +**-V**, **--version** +Print version # SUBCOMMANDS -nanocl-namespace(1) - -: Manage namespaces - -nanocl-secret(1) - -: Manage secrets - -nanocl-job(1) - -: Manage jobs - -nanocl-cargo(1) - -: Manage cargoes - -nanocl-vm(1) - -: Manage virtual machines - -nanocl-resource(1) - -: Manage resources - -nanocl-metric(1) - -: Manage metrics - -nanocl-context(1) - -: Manage contexts - -nanocl-node(1) - -: Manage nodes (experimental) - -nanocl-state(1) +nanocl-namespace(1) +Manage namespaces -: Apply or Remove a Statefile +nanocl-secret(1) +Manage secrets -nanocl-event(1) +nanocl-job(1) +Manage jobs -: Show or watch events +nanocl-cargo(1) +Manage cargoes -nanocl-ps(1) +nanocl-vm(1) +Manage virtual machines -: Show processes +nanocl-resource(1) +Manage resources -nanocl-info(1) +nanocl-metric(1) +Manage metrics -: Show nanocl host information +nanocl-context(1) +Manage contexts -nanocl-version(1) +nanocl-node(1) +Manage nodes (experimental) -: Show nanocl version information +nanocl-state(1) +Apply or Remove a Statefile -nanocl-install(1) +nanocl-event(1) +Show or watch events -: Install components +nanocl-ps(1) +Show processes -nanocl-uninstall(1) +nanocl-info(1) +Show nanocl host information -: Uninstall components +nanocl-version(1) +Show nanocl version information -nanocl-backup(1) +nanocl-install(1) +Install components -: Backup the current state +nanocl-uninstall(1) +Uninstall components -nanocl-help(1) +nanocl-backup(1) +Backup the current state -: Print this message or the help of the given subcommand(s) +nanocl-help(1) +Print this message or the help of the given subcommand(s) # VERSION diff --git a/doc/man/readme.md b/doc/man/readme.md index 0505218b2..8d3a69794 100644 --- a/doc/man/readme.md +++ b/doc/man/readme.md @@ -7,15 +7,14 @@ With `scripts/generate_man.sh` script. ## Summary -* [nanocl.md](./nanocl.md) * [nanocl-backup.md](./nanocl-backup.md) -* [nanocl-cargo.md](./nanocl-cargo.md) * [nanocl-cargo-create.md](./nanocl-cargo-create.md) * [nanocl-cargo-exec.md](./nanocl-cargo-exec.md) * [nanocl-cargo-history.md](./nanocl-cargo-history.md) * [nanocl-cargo-inspect.md](./nanocl-cargo-inspect.md) * [nanocl-cargo-list.md](./nanocl-cargo-list.md) * [nanocl-cargo-logs.md](./nanocl-cargo-logs.md) +* [nanocl-cargo.md](./nanocl-cargo.md) * [nanocl-cargo-patch.md](./nanocl-cargo-patch.md) * [nanocl-cargo-remove.md](./nanocl-cargo-remove.md) * [nanocl-cargo-restart.md](./nanocl-cargo-restart.md) @@ -24,65 +23,66 @@ With `scripts/generate_man.sh` script. * [nanocl-cargo-start.md](./nanocl-cargo-start.md) * [nanocl-cargo-stats.md](./nanocl-cargo-stats.md) * [nanocl-cargo-stop.md](./nanocl-cargo-stop.md) -* [nanocl-context.md](./nanocl-context.md) * [nanocl-context-from.md](./nanocl-context-from.md) * [nanocl-context-list.md](./nanocl-context-list.md) +* [nanocl-context.md](./nanocl-context.md) * [nanocl-context-use.md](./nanocl-context-use.md) -* [nanocl-event.md](./nanocl-event.md) * [nanocl-event-inspect.md](./nanocl-event-inspect.md) * [nanocl-event-list.md](./nanocl-event-list.md) +* [nanocl-event.md](./nanocl-event.md) * [nanocl-event-watch.md](./nanocl-event-watch.md) * [nanocl-info.md](./nanocl-info.md) * [nanocl-install.md](./nanocl-install.md) -* [nanocl-job.md](./nanocl-job.md) * [nanocl-job-inspect.md](./nanocl-job-inspect.md) * [nanocl-job-list.md](./nanocl-job-list.md) * [nanocl-job-logs.md](./nanocl-job-logs.md) +* [nanocl-job.md](./nanocl-job.md) * [nanocl-job-remove.md](./nanocl-job-remove.md) * [nanocl-job-start.md](./nanocl-job-start.md) * [nanocl-job-wait.md](./nanocl-job-wait.md) -* [nanocl-metric.md](./nanocl-metric.md) +* [nanocl.md](./nanocl.md) * [nanocl-metric-inspect.md](./nanocl-metric-inspect.md) * [nanocl-metric-list.md](./nanocl-metric-list.md) -* [nanocl-namespace.md](./nanocl-namespace.md) +* [nanocl-metric.md](./nanocl-metric.md) * [nanocl-namespace-create.md](./nanocl-namespace-create.md) * [nanocl-namespace-inspect.md](./nanocl-namespace-inspect.md) * [nanocl-namespace-list.md](./nanocl-namespace-list.md) +* [nanocl-namespace.md](./nanocl-namespace.md) * [nanocl-namespace-remove.md](./nanocl-namespace-remove.md) -* [nanocl-node.md](./nanocl-node.md) * [nanocl-node-list.md](./nanocl-node-list.md) +* [nanocl-node.md](./nanocl-node.md) * [nanocl-ps.md](./nanocl-ps.md) -* [nanocl-resource.md](./nanocl-resource.md) * [nanocl-resource-history.md](./nanocl-resource-history.md) * [nanocl-resource-inspect.md](./nanocl-resource-inspect.md) * [nanocl-resource-list.md](./nanocl-resource-list.md) +* [nanocl-resource.md](./nanocl-resource.md) * [nanocl-resource-remove.md](./nanocl-resource-remove.md) * [nanocl-resource-revert.md](./nanocl-resource-revert.md) -* [nanocl-secret.md](./nanocl-secret.md) -* [nanocl-secret-create.md](./nanocl-secret-create.md) * [nanocl-secret-create-container-registry.md](./nanocl-secret-create-container-registry.md) * [nanocl-secret-create-env.md](./nanocl-secret-create-env.md) +* [nanocl-secret-create.md](./nanocl-secret-create.md) * [nanocl-secret-create-tls.md](./nanocl-secret-create-tls.md) * [nanocl-secret-inspect.md](./nanocl-secret-inspect.md) * [nanocl-secret-list.md](./nanocl-secret-list.md) +* [nanocl-secret.md](./nanocl-secret.md) * [nanocl-secret-remove.md](./nanocl-secret-remove.md) -* [nanocl-state.md](./nanocl-state.md) * [nanocl-state-apply.md](./nanocl-state-apply.md) * [nanocl-state-logs.md](./nanocl-state-logs.md) +* [nanocl-state.md](./nanocl-state.md) * [nanocl-state-remove.md](./nanocl-state-remove.md) * [nanocl-uninstall.md](./nanocl-uninstall.md) * [nanocl-version.md](./nanocl-version.md) -* [nanocl-vm.md](./nanocl-vm.md) * [nanocl-vm-attach.md](./nanocl-vm-attach.md) * [nanocl-vm-create.md](./nanocl-vm-create.md) -* [nanocl-vm-image.md](./nanocl-vm-image.md) * [nanocl-vm-image-clone.md](./nanocl-vm-image-clone.md) * [nanocl-vm-image-create.md](./nanocl-vm-image-create.md) * [nanocl-vm-image-list.md](./nanocl-vm-image-list.md) +* [nanocl-vm-image.md](./nanocl-vm-image.md) * [nanocl-vm-image-remove.md](./nanocl-vm-image-remove.md) * [nanocl-vm-image-resize.md](./nanocl-vm-image-resize.md) * [nanocl-vm-inspect.md](./nanocl-vm-inspect.md) * [nanocl-vm-list.md](./nanocl-vm-list.md) +* [nanocl-vm.md](./nanocl-vm.md) * [nanocl-vm-patch.md](./nanocl-vm-patch.md) * [nanocl-vm-remove.md](./nanocl-vm-remove.md) * [nanocl-vm-run.md](./nanocl-vm-run.md) diff --git a/scripts/generate_man.sh b/scripts/generate_man.sh index 49b3c19f6..c790de617 100755 --- a/scripts/generate_man.sh +++ b/scripts/generate_man.sh @@ -7,9 +7,29 @@ for project in ./bin/*; do continue fi - for file in $project/target/man/*; do + count=1 + for file in $(ls $project/target/man/*); do + echo "Processing $file" file_name=$(basename "${file}") - pandoc --from man --to markdown < $file > ./doc/man/${file_name%.1}.md + # replace - with _ in the file name + # replace nanocl with nanocl_ in the file name + title=$(echo ${file_name%.1} | sed 's/nanocl-//g' | sed 's/-/ /g' | sed 's/.*/\u&/') + echo "--- +title: ${title} +sidebar_position: ${count} +--- + +# ${title} +" > ./doc/man/${file_name%.1}.md + pandoc --from man --to gfm < $file >> ./doc/man/${file_name%.1}.md + awk '/^# NAME/{flag=1; next} /^# SYNOPSIS/{flag=0} !flag' ./doc/man/${file_name%.1}.md | sponge ./doc/man/${file_name%.1}.md + # Replace # SYNOPSIS with ## SYNOPSIS + sed -i "s/^# SYNOPSIS/## SYNOPSIS/" -i ./doc/man/${file_name%.1}.md + # Replace # DESCRIPTION with ## DESCRIPTION + sed -i "s/^# DESCRIPTION/## DESCRIPTION/" -i ./doc/man/${file_name%.1}.md + # Replace # OPTIONS with ## OPTIONS + sed -i "s/^# OPTIONS/## OPTIONS/" -i ./doc/man/${file_name%.1}.md + count=$((count+1)) done done @@ -23,7 +43,8 @@ With \`scripts/generate_man.sh\` script. ## Summary """ > ./doc/man/readme.md -for file in $(ls -v ./doc/man/*); do +for file in $(ls ./doc/man/*); do + echo "Processing $file" file_name=$(basename "${file}") if [ "$file_name" = "readme.md" ]; then continue