Skip to content

Commit

Permalink
generate doc + TestAllUsage
Browse files Browse the repository at this point in the history
  • Loading branch information
Mia-Cross committed Jan 11, 2024
1 parent b9698c5 commit e9c9a9a
Show file tree
Hide file tree
Showing 23 changed files with 85 additions and 85 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Disable the sending of managed alerts for the specified Project's Cockpit.

USAGE:
scw cockpit alert disable [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Enable the sending of managed alerts for the specified Project's Cockpit.

USAGE:
scw cockpit alert enable [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Send a test alert to make sure your contact points get notified when an actual alert is triggered.
Trigger a test alert to all of the Cockpit's receivers.

USAGE:
scw cockpit alert test [arg=value ...]
Expand Down
6 changes: 3 additions & 3 deletions cmd/scw/testdata/test-all-usage-cockpit-alert-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ USAGE:
scw cockpit alert <command>

AVAILABLE COMMANDS:
disable Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to
enable Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to
test Send a test alert to make sure your contact points get notified when an actual alert is triggered
disable Disable the sending of managed alerts for the specified Project's Cockpit
enable Enable the sending of managed alerts for the specified Project's Cockpit
test Trigger a test alert to all of the Cockpit's receivers

FLAGS:
-h, --help help for alert
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Activate the Cockpit of a given Project specified by the Project ID.
Activate the Cockpit of the specified Project ID.

USAGE:
scw cockpit cockpit activate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Deactivate the Cockpit of a given Project specified by the Project ID.
Deactivate the Cockpit of the specified Project ID.

USAGE:
scw cockpit cockpit deactivate [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve the Cockpit of a given Project specified by the Project ID.
Retrieve the Cockpit of the specified Project ID.

USAGE:
scw cockpit cockpit get [arg=value ...]
Expand Down
6 changes: 3 additions & 3 deletions cmd/scw/testdata/test-all-usage-cockpit-cockpit-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ USAGE:
scw cockpit cockpit <command>

AVAILABLE COMMANDS:
activate Activate the Cockpit of a given Project specified by the Project ID
deactivate Deactivate the Cockpit of a given Project specified by the Project ID
get Retrieve the Cockpit of a given Project specified by the Project ID
activate Activate the Cockpit of the specified Project ID
deactivate Deactivate the Cockpit of the specified Project ID
get Retrieve the Cockpit of the specified Project ID

WORKFLOW COMMANDS:
wait Wait for a cockpit to reach a stable state (installation)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a contact point associated with the default receiver, to receive alerts.
Create a contact point to receive alerts for the default receiver.

USAGE:
scw cockpit contact create [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a contact point associated with the default receiver.
Delete a contact point for the default receiver.

USAGE:
scw cockpit contact delete [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Get a list of contact points for the Cockpit associated with the specified Project ID.

USAGE:
scw cockpit contact list [arg=value ...]
Expand Down
6 changes: 3 additions & 3 deletions cmd/scw/testdata/test-all-usage-cockpit-contact-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ USAGE:
scw cockpit contact <command>

AVAILABLE COMMANDS:
create Create a contact point associated with the default receiver, to receive alerts
delete Delete a contact point associated with the default receiver
list Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to
create Create a contact point to receive alerts for the default receiver
delete Delete a contact point for the default receiver
list Get a list of contact points for the Cockpit associated with the specified Project ID

FLAGS:
-h, --help help for contact
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID.
Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID.

USAGE:
scw cockpit grafana-user create [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID.

USAGE:
scw cockpit grafana-user delete [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a list of all Grafana users created in your Cockpit's Grafana.
Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance.

USAGE:
scw cockpit grafana-user list [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID.

USAGE:
scw cockpit grafana-user reset-password [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ USAGE:
scw cockpit grafana-user <command>

AVAILABLE COMMANDS:
create Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID
delete Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user
list Get a list of all Grafana users created in your Cockpit's Grafana
reset-password Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user
create Create a Grafana user for your Cockpit's Grafana instance. Make sure you save the automatically-generated password and the Grafana user ID
delete Delete a Grafana user from a Grafana instance, specified by the Cockpit's Project ID and the Grafana user ID
list Get a list of Grafana users who are able to connect to the Cockpit's Grafana instance
reset-password Reset a Grafana user's password specified by the Cockpit's Project ID and the Grafana user ID

FLAGS:
-h, --help help for grafana-user
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a token in a given Project specified by the Project ID.
Create a token associated with the specified Project ID.

USAGE:
scw cockpit token create [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a given token specified by the token ID.
Delete the token associated with the specified token ID.

USAGE:
scw cockpit token delete [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve a given token specified by the token ID.
Retrieve the token associated with the specified token ID.

USAGE:
scw cockpit token get <token-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a list of tokens in a given Project specified by the Project ID.
Get a list of tokens associated with the specified Project ID.

USAGE:
scw cockpit token list [arg=value ...]
Expand Down
8 changes: 4 additions & 4 deletions cmd/scw/testdata/test-all-usage-cockpit-token-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ USAGE:
scw cockpit token <command>

AVAILABLE COMMANDS:
create Create a token in a given Project specified by the Project ID
delete Delete a given token specified by the token ID
get Retrieve a given token specified by the token ID
list Get a list of tokens in a given Project specified by the Project ID
create Create a token associated with the specified Project ID
delete Delete the token associated with the specified token ID
get Retrieve the token associated with the specified token ID
list Get a list of tokens associated with the specified Project ID

FLAGS:
-h, --help help for token
Expand Down
Loading

0 comments on commit e9c9a9a

Please sign in to comment.