Skip to content

fix(cockpit): fix documentation string on preconfigured rules #4700

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

fix(cockpit): fix documentation string on preconfigured rules #4700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cmd/scw/testdata/test-all-usage-container-container-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ ARGS:
[health-check.http.path] Path to use for the HTTP health check.
[health-check.failure-threshold] Number of consecutive health check failures before considering the container unhealthy.
[health-check.interval] Period between health checks.
[tags.{index}] Tags of the Serverless Container
[deploy=true] Deploy container after creation
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

Expand Down
1 change: 1 addition & 0 deletions cmd/scw/testdata/test-all-usage-container-container-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ ARGS:
[health-check.http.path] Path to use for the HTTP health check.
[health-check.failure-threshold] Number of consecutive health check failures before considering the container unhealthy.
[health-check.interval] Period between health checks.
[tags.{index}] Tags of the Serverless Container
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

DEPRECATED ARGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-container-namespace-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ARGS:
[description] Description of the namespace to create
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[tags.{index}] [ALPHA] Tags of the Serverless Container Namespace
[tags.{index}] Tags of the Serverless Container Namespace
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-container-namespace-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[description] Description of the namespace to update
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[tags.{index}] [ALPHA] Tags of the Serverless Container Namespace
[tags.{index}] Tags of the Serverless Container Namespace
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
1 change: 1 addition & 0 deletions cmd/scw/testdata/test-all-usage-function-function-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ ARGS:
[secret-environment-variables.{index}.value]
[http-option=enabled] Configure how HTTP and HTTPS requests are handled (unknown_http_option | enabled | redirected)
[sandbox] Execution environment of the function (unknown_sandbox | v1 | v2)
[tags.{index}] Tags of the Serverless Function
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
1 change: 1 addition & 0 deletions cmd/scw/testdata/test-all-usage-function-function-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ ARGS:
[secret-environment-variables.{index}.value]
[http-option] Configure how HTTP and HTTPS requests are handled (unknown_http_option | enabled | redirected)
[sandbox] Execution environment of the function (unknown_sandbox | v1 | v2)
[tags.{index}] Tags of the Serverless Function
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-function-namespace-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ARGS:
[description] Description of the namespace
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[tags.{index}] [ALPHA] Tags of the Serverless Function Namespace
[tags.{index}] Tags of the Serverless Function Namespace
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-function-namespace-update-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[description] Description of the namespace
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[tags.{index}] [ALPHA] Tags of the Serverless Function Namespace
[tags.{index}] Tags of the Serverless Function Namespace
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
6 changes: 4 additions & 2 deletions docs/commands/container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ scw container container create [arg=value ...]
| health-check.http.path | | Path to use for the HTTP health check. |
| health-check.failure-threshold | | Number of consecutive health check failures before considering the container unhealthy. |
| health-check.interval | | Period between health checks. |
| tags.{index} | | Tags of the Serverless Container |
| deploy | Default: `true` | Deploy container after creation |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |

Expand Down Expand Up @@ -214,6 +215,7 @@ scw container container update <container-id ...> [arg=value ...]
| health-check.http.path | | Path to use for the HTTP health check. |
| health-check.failure-threshold | | Number of consecutive health check failures before considering the container unhealthy. |
| health-check.interval | | Period between health checks. |
| tags.{index} | | Tags of the Serverless Container |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -474,7 +476,7 @@ scw container namespace create [arg=value ...]
| description | | Description of the namespace to create |
| secret-environment-variables.{index}.key | | |
| secret-environment-variables.{index}.value | | |
| tags.{index} | | [ALPHA] Tags of the Serverless Container Namespace |
| tags.{index} | | Tags of the Serverless Container Namespace |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -562,7 +564,7 @@ scw container namespace update <namespace-id ...> [arg=value ...]
| description | | Description of the namespace to update |
| secret-environment-variables.{index}.key | | |
| secret-environment-variables.{index}.value | | |
| tags.{index} | | [ALPHA] Tags of the Serverless Container Namespace |
| tags.{index} | | Tags of the Serverless Container Namespace |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down
6 changes: 4 additions & 2 deletions docs/commands/function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ scw function function create [arg=value ...]
| secret-environment-variables.{index}.value | | |
| http-option | Default: `enabled`<br />One of: `unknown_http_option`, `enabled`, `redirected` | Configure how HTTP and HTTPS requests are handled |
| sandbox | One of: `unknown_sandbox`, `v1`, `v2` | Execution environment of the function |
| tags.{index} | | Tags of the Serverless Function |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -463,6 +464,7 @@ scw function function update <function-id ...> [arg=value ...]
| secret-environment-variables.{index}.value | | |
| http-option | One of: `unknown_http_option`, `enabled`, `redirected` | Configure how HTTP and HTTPS requests are handled |
| sandbox | One of: `unknown_sandbox`, `v1`, `v2` | Execution environment of the function |
| tags.{index} | | Tags of the Serverless Function |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -493,7 +495,7 @@ scw function namespace create [arg=value ...]
| description | | Description of the namespace |
| secret-environment-variables.{index}.key | | |
| secret-environment-variables.{index}.value | | |
| tags.{index} | | [ALPHA] Tags of the Serverless Function Namespace |
| tags.{index} | | Tags of the Serverless Function Namespace |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -581,7 +583,7 @@ scw function namespace update <namespace-id ...> [arg=value ...]
| description | | Description of the namespace |
| secret-environment-variables.{index}.key | | |
| secret-environment-variables.{index}.value | | |
| tags.{index} | | [ALPHA] Tags of the Serverless Function Namespace |
| tags.{index} | | Tags of the Serverless Function Namespace |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ require (
github.com/mattn/go-isatty v0.0.20
github.com/moby/buildkit v0.13.2
github.com/opencontainers/go-digest v1.0.0
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250422095315-6f998f4655ec
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250502134911-8e9702aa2a77
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
github.com/spf13/cobra v1.9.1
github.com/spf13/pflag v1.0.6
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250422095315-6f998f4655ec h1:XLNQFZzigDYXgdRHPxuV3w5VnKvnsCVbl8HBpvDYu40=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250422095315-6f998f4655ec/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250502134911-8e9702aa2a77 h1:PrRutFdLjGTw4ULbymArBYDEuxk/n2BWy0mGKwCe4Fk=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250502134911-8e9702aa2a77/go.mod h1:w4o02EHpO0CBGy2nehzWRaFQKd62G9HIf+Q07PDaUcE=
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=
Expand Down
3 changes: 2 additions & 1 deletion internal/namespaces/container/v1beta1/testdata/test-create-simple.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,6 @@ Region fr-par
"created_at": null,
"updated_at": null,
"ready_at": null,
"region": "fr-par"
"region": "fr-par",
"tags": null
}
3 changes: 2 additions & 1 deletion internal/namespaces/function/v1beta1/testdata/test-deploy-simple.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,6 @@ Sandbox unknown_sandbox
"sandbox": "unknown_sandbox",
"created_at": null,
"updated_at": null,
"ready_at": null
"ready_at": null,
"tags": null
}
2 changes: 0 additions & 2 deletions internal/namespaces/k8s/v1/testdata/test-get-cluster-simple.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ UpdatedAt few seconds ago
UpgradeAvailable true
PrivateNetworkID 42299907-e54a-4454-9afd-7146b9ab28d2
CommitmentEndsAt few seconds ago
SbsCsiEnabled true
IamNodesGroupID -

Autoscaler configuration:
Expand Down Expand Up @@ -98,7 +97,6 @@ ID NAME STATUS VERSION NODE TYPE MIN
"apiserver_cert_sans": [],
"private_network_id": "42299907-e54a-4454-9afd-7146b9ab28d2",
"commitment_ends_at": "1970-01-01T00:00:00.0Z",
"sbs_csi_enabled": true,
"iam_nodes_group_id": "",
"pools": [
{
Expand Down
2 changes: 0 additions & 2 deletions internal/namespaces/k8s/v1/testdata/test-wait-cluster-wait-for-pools.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ UpdatedAt few seconds ago
UpgradeAvailable true
PrivateNetworkID 99b960e4-e830-4979-baab-40184b9b8209
CommitmentEndsAt few seconds ago
SbsCsiEnabled true
IamNodesGroupID -

Autoscaler configuration:
Expand Down Expand Up @@ -94,6 +93,5 @@ GroupsPrefix -
"apiserver_cert_sans": [],
"private_network_id": "99b960e4-e830-4979-baab-40184b9b8209",
"commitment_ends_at": "1970-01-01T00:00:00.0Z",
"sbs_csi_enabled": true,
"iam_nodes_group_id": ""
}
Loading