cockpit.md

Documentation for scw cockpit

This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.

• Alerting management commands
  • Disable the Alert manager
  • Enable the Alert manager
  • Get the Alert manager
• Contact point management commands
  • Create a contact point
  • Delete a contact point
  • List contact points
• Datasource management commands
  • Create a data source
  • Delete a data source
  • Get a data source
  • List data sources
  • Update a data source
• Grafana user management commands
  • Get your Cockpit's Grafana
  • Synchronize Grafana data sources
• Grafana user management commands
  • Create a Grafana user
  • Delete a Grafana user
  • List Grafana users
  • Reset a Grafana user password
• Managed alerts management commands
  • Disable managed alerts
  • Enable managed alerts
• Pricing plans management commands
  • Get current plan
  • List plan types
  • Apply a pricing plan
• Product dashboards management commands
  • Get Scaleway resource dashboard
  • List Scaleway resources dashboards
• Test alert management commands
  • Trigger a test alert
• Token management commands
  • Create a token
  • Delete a token
  • Get a token
  • List tokens
• Usage overview management commands
  • Get data source usage overview

Alerting management commands

Alerting management commands.

Disable the Alert manager

Disabling the Alert manager deletes the contact points you have created and disables managed alerts in the specified Project and region.

Usage:

scw cockpit alert-manager disable [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Enable the Alert manager

Enabling the Alert manager allows you to enable managed alerts and create contact points in the specified Project and region, to be notified when your Scaleway resources may require your attention.

Usage:

scw cockpit alert-manager enable [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Get the Alert manager

Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled. The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled.

Usage:

scw cockpit alert-manager get [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Contact point management commands

Contact point management commands.

Create a contact point

Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to. The source of the alerts are data sources within the same Project and region as the Alert manager. If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager.

Usage:

scw cockpit contact-point create [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
email.to
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Delete a contact point

Delete a contact point associated with the default receiver.

Usage:

scw cockpit contact-point delete [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
email.to
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

List contact points

Retrieve a list of contact points for the specified Project. The response lists all contact points and receivers created in Grafana or via the API.

Usage:

scw cockpit contact-point list [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw, all	Region to target. If none is passed will use default region from the config

Datasource management commands

Datasource management commands.

Create a data source

You must specify the data source type upon creation. Available data source types include:

• metrics
• logs
• traces The name of the data source will then be used as reference to name the associated Grafana data source.

Usage:

scw cockpit data-source create [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
name		Data source name
type	One of: unknown_type, metrics, logs, traces	Data source type
retention-days		BETA - Duration for which the data will be retained in the data source
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Delete a data source

Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.

Usage:

scw cockpit data-source delete [arg=value ...]

Args:

Name		Description
data-source-id	Required	ID of the data source to delete
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Get a data source

Retrieve information about a given data source, specified by the data source ID. The data source's information such as its name, type, URL, origin, and retention period, is returned.

Usage:

scw cockpit data-source get [arg=value ...]

Args:

Name		Description
data-source-id	Required	ID of the relevant data source
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

List data sources

Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order. You can list data sources by Project, type and origin.

Usage:

scw cockpit data-source list [arg=value ...]

Args:

Name		Description
order-by	One of: created_at_asc, created_at_desc, name_asc, name_desc, type_asc, type_desc	Sort order for data sources in the response
project-id		Project ID to use. If none is passed the default project ID will be used
origin	One of: unknown_origin, scaleway, external, custom	Origin to filter for, only data sources with matching origin will be returned
types.{index}	One of: unknown_type, metrics, logs, traces	Types to filter for, only data sources with matching types will be returned
region	Default: fr-par One of: fr-par, nl-ams, pl-waw, all	Region to target. If none is passed will use default region from the config

Update a data source

Update a given data source name, specified by the data source ID.

Usage:

scw cockpit data-source update [arg=value ...]

Args:

Name		Description
data-source-id	Required	ID of the data source to update
name		Updated name of the data source
retention-days		BETA - Duration for which the data will be retained in the data source
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Grafana user management commands

Grafana user management commands.

Get your Cockpit's Grafana

Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to. The output returned displays the URL to access your Cockpit's Grafana.

Usage:

scw cockpit grafana get [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used

Synchronize Grafana data sources

Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it.

Usage:

scw cockpit grafana sync-data-sources [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used

Grafana user management commands

Grafana user management commands.

Create a Grafana user

Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the admin username is not available for creation.

Usage:

scw cockpit grafana-user create [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
login		Username of the Grafana user. Note that the admin username is not available for creation
role	One of: unknown_role, editor, viewer	Role assigned to the Grafana user

Delete a Grafana user

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.

Usage:

scw cockpit grafana-user delete [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
grafana-user-id	Required	ID of the Grafana user

List Grafana users

List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.

Usage:

scw cockpit grafana-user list [arg=value ...]

Args:

Name		Description
order-by	One of: login_asc, login_desc	Order of the Grafana users
project-id		Project ID to use. If none is passed the default project ID will be used

Reset a Grafana user 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. A new password regenerates and only displays once. Make sure that you save it.

Usage:

scw cockpit grafana-user reset-password [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
grafana-user-id	Required	ID of the Grafana user

Managed alerts management commands

Managed alerts management commands.

Disable managed alerts

Disable the sending of managed alerts for the specified Project.

Usage:

scw cockpit managed-alerts disable [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Enable managed alerts

Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.

Usage:

scw cockpit managed-alerts enable [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Pricing plans management commands

Pricing plans management commands.

Get current plan

Retrieve a pricing plan for the given Project, specified by the ID of the Project. Deprecated, retention is now managed at the data source level.

Usage:

scw cockpit plan get [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used

List plan types

Retrieve a list of available pricing plan types. Deprecated, retention is now managed at the data source level.

Usage:

scw cockpit plan list [arg=value ...]

Args:

Name		Description
order-by	One of: name_asc, name_desc

Apply a pricing plan

Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. Deprecated, retention is now managed at the data source level.

Usage:

scw cockpit plan select [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
plan-name	One of: unknown_name, free, premium, custom	Name of the pricing plan

Product dashboards management commands

Product dashboards management commands.

Get Scaleway resource dashboard

Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard.

Usage:

scw cockpit product-dashboards get [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
dashboard-name	Required	Name of the dashboard

List Scaleway resources dashboards

Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit.

Usage:

scw cockpit product-dashboards list [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
tags.{index}		Tags to filter for

Test alert management commands

Test alert management commands.

Trigger a test alert

Send a test alert to the Alert manager to make sure your contact points get notified.

Usage:

scw cockpit test-alert trigger [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Token management commands

Token management commands.

Create a token

Give your token the relevant scopes to ensure it has the right permissions to interact with your data sources and the Alert manager. Make sure that you create your token in the same regions as the data sources you want to use it for. Upon creation, your token's secret key display only once. Make sure that you save it.

Usage:

scw cockpit token create [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
name		Name of the token
token-scopes.{index}	One of: unknown_scope, read_only_metrics, write_only_metrics, full_access_metrics_rules, read_only_logs, write_only_logs, full_access_logs_rules, full_access_alert_manager, read_only_traces, write_only_traces	Token permission scopes
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Delete a token

Delete a given token, specified by the token ID. Deleting a token is irreversible and cannot be undone.

Usage:

scw cockpit token delete [arg=value ...]

Args:

Name		Description
token-id	Required	ID of the token to delete
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

Get a token

Retrieve information about a given token, specified by the token ID. The token's information such as its scopes, is returned.

Usage:

scw cockpit token get [arg=value ...]

Args:

Name		Description
token-id	Required	Token ID
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config

List tokens

Retrieve a list of all tokens in the specified region. By default, tokens returned in the list are ordered by creation date, in ascending order. You can filter tokens by Project ID and token scopes.

Usage:

scw cockpit token list [arg=value ...]

Args:

Name		Description
order-by	One of: created_at_asc, created_at_desc, name_asc, name_desc	Order in which to return results
project-id		Project ID to use. If none is passed the default project ID will be used
token-scopes.{index}	One of: unknown_scope, read_only_metrics, write_only_metrics, full_access_metrics_rules, read_only_logs, write_only_logs, full_access_logs_rules, full_access_alert_manager, read_only_traces, write_only_traces	Token scopes to filter for
region	Default: fr-par One of: fr-par, nl-ams, pl-waw, all	Region to target. If none is passed will use default region from the config

Usage overview management commands

Usage overview management commands.

Get data source usage overview

Retrieve the data source usage overview per type for the specified Project.

Usage:

scw cockpit usage-overview get [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
interval
region	Default: fr-par One of: fr-par, nl-ams, pl-waw	Region to target. If none is passed will use default region from the config