Configuration

Useful Tip:

Instead of running configuration commands in Slack, visit https://dashboard.opsidian.ai to configure Opsidian with our easy to use web dashboard.

Users

Displaying user management help
/ops user help
Adding Slack users to Opsidian

Opsidian users are divided into two groups: admins and standard users. Standard users can query AWS resources and trigger lambda commands and scripts. Admin users can additionally configure Opsidian.
To add a Slack user as an Opsidian standard user, run the following command:

/ops user add <username> standard

To add a Slack user as an Opsidian admin, run the following command:

/ops user add <username> admin
Examples:

                  /ops user add @john

/ops user add @john standard

/ops user add @john admin
Updating users

In order to change the user's role to admin, run:

/ops user update <username> admin

In order to change the user's role to standard, run:

/ops user update <username> standard
Examples:

                  /ops user update @john admin

/ops user update @john standard
Removing users from Opsidian

In order to remove a Slack user from Opsidian and prevent him from running Opsidian commands, run:

/ops user delete <username>
Examples:

                  /ops user delete @john
                  
Displaying the list of Opsidian users

To display the list of all Opsidian users, run:

/ops user list

To display the list Opsidian admins, run:

/ops user list admin

To display the list of Opsidian standard users, run:

/ops user list standard

Accounts

Displaying account management help
/ops account help
Displaying the list of configured AWS accounts
/ops account list
Displaying instructions for connecting Opsidian to your AWS account
/ops account configure
Sending configuration instructions

To send instructions for connecting Opsidian to your AWS accounts to user <username>, run the following command:

/ops account configure request <username>
Examples:

                  /ops account configure request @john
                  
Displaying account details

To display details of account <account_name>, run:

/ops account show <account_name>
Examples:

                  /ops account show devAccount
                  
Adding an AWS account to Opsidian using access keys

To configure a new AWS account <account_name> with the default region set to <region_name> and access keys to a user with a read-only policy attached (read more.), run:

/ops account add keys name=<account_name> key=<aws_access_key_id> secret=<aws_secret_key> region=<region_name>
Examples:

                  /ops account add keys name=devAccount key=key1 secret=secret1 region=eu-west-1
                  
Adding an AWS account to Opsidian using a cross-account role

To configure a new AWS account <account_name> with the default region set to <region_name> and a <role_arn> for a cross-account role with access to AWS resources (read more.), run:

/ops account add cross-account name=<account_name> arn=<role_arn> region=<region_name>
Examples:

                  /ops account add cross-account name=devAccount arn=arn1 region=eu-west-1
                  
Updating an account to use access keys

To update the account <account_name>, run:

/ops account update keys <account_name> [default] [key=<aws_access_key_id>] [secret=<aws_secret_key>] [region=<region_name>]

At least one of the parameters is required.

Examples:

                  /ops account update keys devAccount default

/ops account update keys devAccount key=key2

/ops account update keys devAccount key=key3 secret=secret3

/ops account update keys devAccount region=eu-west-1
Updating an account to use a cross-account role

To update the account <account_name>, run:

/ops account update cross-account <account_name> [default] [arn=<role_arn>] [region=<region_name>]

At least one of the parameters is required.

Examples:

                  /ops account update cross-account devAccount default

/ops account update cross-account devAccount arn=arn2

/ops account update cross-account devAccount region=eu-west-1
Deleting accounts from Opsidian
To remove account <account_name> from Opsidian, run:
/ops account delete <account_name>
Examples:

                  /ops account delete devAccount
                  
Listing AWS regions
/ops account list regions
Using different accounts in commands

It is possible to configure multiple AWS accounts. One account is set as the default one (use /ops account update <account_name> default to change the default account). Each command can be run with the account <account_name> parameter:

/ops <service> <command> [account <account_name>] [region <region_name>]

Examples:

                  /ops ec2 list instances account devAccount

/ops ec2 list instances account devAccount region eu-west-1

Alarms

Displaying instructions on how to subscribe to alarms

In order to display instructions on how to subscribe a Slack channel to AWS alarms, run:

/ops alarms configure
Listing SNS topics that the channel is subscribed to
/ops alarms list topics
Displaying an unsubscribe link for an SNS topic
/ops alarms unsubscribe <topic_arn>
Listing cloudwatch alarms in a given account and region
/ops alarms list alarms
Displaying configuration settings of an alarm
/ops alarms show alarm <alarm_name>
Silencing alarms
/ops alarms silence alarm <alarm_name>
Unsilencing alarms
/ops alarms unsilence alarm <alarm_name>
Snoozing alarms for a period of time
/ops alarms snooze alarm <alarm_name>
Unsnoozing alarms
/ops alarms unsnooze alarm <alarm_name>
Toggling automatic plots
/ops alarms plots alarm <alarm_name> <on/off>
Adding notes to alarms
/ops alarms notes alarm <alarm_name> add <note>

The notes will be displayed along with the alarm notification in Slack. This way the whole team will see the notes associated with the alarm.

Clearing notes
/ops alarms notes alarm <alarm_name> clear
Using different accounts and regions
/ops alarms <command> [account <account_name>] [region <region_name>]
Examples:

                  /ops alarms show alarm myAlarm

/ops alarms silence alarm myAlarm

/ops alarms unsilence alarm myAlarm

/ops alarms snooze alarm myAlarm

/ops alarms unsnooze alarm myAlarm

/ops alarms plots alarm myAlarm off

/ops alarms notes alarm myAlarm add Restart the EC2 instance

/ops alarms notes alarm myAlarm clear

Channels

Useful Tip:

If no default account is set for a channel, then the global default account will be used when the account parameter is not specified.

Setting the default account in the current channel
/ops channel default <account_name>
Examples:

                  /ops channel default devAccount
                  
Displaying the default account in the current channel
/ops channel show default
Clearing the default account in the current channel
/ops channel delete default

Logging

Logging Opsidian commands

In order to see what Opsidian commands were executed by Slack users, you can forward Opsidian logs to an SNS topic. Run the following command:

/ops logs configure

After the SNS topic for Opsidian logs in configured, you can subscribe to notifications from this topic in a selected Slack channel:

/ops alarms configure

Every Opsidian command executed by Slack users will be visible in this channel.

Powered by PrettyDocs.

Address

Antinkatu 1 A
00100 Helsinki, Finland
Business ID: 2670712-7
© Opsidian 2018