Overview
Key Concepts
General
- Index
- Favorites
- User Getting Started
- General
- User Key Concepts
- Search
- User Testing and Debugging
- User Interface
Account
- Index
- Add a Group to an Organization
- Add a New Azure Cloud
- Add a New Cloud
- Add a User To a Group
- Add a User
- Add a User to a Team
- Azure Setup
- Azure
- Catalogs
- Clouds
- Cost Management
- Create a Team in an Organization
- Delete a Platform
- Deploy an Organization
- Deployment Approval Process
- Enable Access to an Assembly for a User on a Team
- Environment Profiles
- How Cost Tracking and Reporting Works
- Import and Export Catalog
- Account
- Manage OneOps User Accounts
- Notifications
- OneOps Policy Management
- Organization Summary
- Provide Only Necessary Privileges to Accounts
- Reports Summary
- Restrict Access with Teams
- Secrets Proxy
- Security Groups
- Shutdown a Cloud
- View a Reports Summary
- View, Add, or Edit Environment Profiles
- View an Organization Summary
- View Assembly and Organization Consumption with Reports
Design
- Index
- Add a Platform to a Design
- Add a Variable
- Add ELK Stack to an Application
- Add or Delete a Security Group to Open or Close an Additional Port
- Add a Team to an Assembly
- Apache HTTP Server Component
- Apache HTTP Server Pack
- Apache Tomcat Pack
- Artifact Component
- Attachments
- Variables Override Prevention
- Certificate Component
- Chocolatey Package Component
- Components
- Compute Component
- Create Assemblies to Design Applications
- Create Environment Dependency with Environment Profiles
- Daemon Component
- Design Best Practices
- Download Component
- Edit a Platform
- Enable https for a Service (LB Certs)
- File Component
- Filebeat Component
- Firewall Component
- Fully Qualified Domain Name FQDN
- Hostname Component
- Design
- Java Component
- Job Component
- Keystore Component
- Load Balancer Component
- Library Component
- Load/Extract
- Logstash Component
- Manage Assemblies
- DotNet Framework Component
- Microsoft IIS Pack
- IIS Website Component
- Microsoft SQL Server Pack
- Naming Conventions
- NuGet Package Component
- Objectstore Component
- Operating System Component
- Packs
- Platform Links
- Platforms
- Ports by Platform
- Propagation
- Security Group Component
- Secrets Client Component
- Sensuclient Component
- Set Up Multiple Ports/Protocols in Load Balancer
- Share Component
- SSH Keys Component
- Storage Component
- Telegraf Component
- Upgrade an Application Version in an Environment
- User Component
- Variables
- View Design Releases
- Volume Component
- Watching an Assembly
- Website Component
Transition
- Index
- Add CNAME in Azure DNS
- Add CNAME
- Add or Edit Primary and Secondary Clouds
- Add or Reduce Capacity
- Availability Modes
- Configure ECV Check URL on OneOps
- Create an Environment
- Delete an Environment
- Deploy Application after Design Changes
- Deploy an Application for the First Time
- Deploy Application With Database
- Deploy an Environment
- Deploy Multiple Clouds in Parallel
- Deploy and Provision an Application and Environment for the First Time
- Edit an Environment
- Email Notification Relay
- Environment Releases
- Environment
- Transition
- Remove an Unused Cloud from an Environment
- Rollback Code
- Set Variable Cloud Scaling Percentage
- Transition Best Practices
- Transition
- View Deployment Status
Operation
- Index
- Assess the Health of Applications, Platforms and Clouds
- Auto Repair
- Auto Replace
- Auto Scale
- Computes in Operation
- Control Environment
- Enable Platform to Auto Replace Unhealthy Components
- Ensure that Alerts for Production Environment are Sent to NOC
- Find a Platform VIP Name
- Grep or Search Text in Files on Computes
- Operation
- Navigation to Monitors
- Monitors
- Operations
- Operations Summary
- Set Up a Custom Action
- Take a Node out of Traffic (ECV Disable)
- Update or Upgrade New OneOps Code
Notifications
A number of events in an organization in OneOps can trigger notifications. These events include deployments, monitors, scale and repair actions.
Notifications can be sent to a number of receiving notification sinks including simple URLs, Jabber, Amazon SNS and Slack.
Configuration
To set up and configure notifications, follow these steps:
- Access the settings for the desired organization
- Click Settings under the specific organization in the left hand navigation
- Alternative click on the settings icon in the header
-
Select the notifications tab.
-
Press the Add button on top of the list of notifications to create a new notification sink.
-
Or click on the name of a specific notification sink in the list to access its configuration in the Details section on the right. Pressing the Edit button allows you to change the configuration.
- Provide all desired values and press Save.
Each notification sink includes a number of generic as well as type-specific configuration settings. The type is selected as a first action when creating a new notification sink.
The generic settings are:
-
Name: the required name of the notification sink.</dd>
-
Global - Description: optional description for the notification sink</dd>
-
Filtering: fine-grained control over which messages are sent is possible with filtering enabled. You can configure filters with criteria such as Event Type, Severity Level, Environment Profile Pattern, NS Paths, Monitoring Clouds and Message Pattern. Typically filtering should be enabled so that specific the notification sync is not flooded by all events for the organization. Instead it can be filtered to e.g. only receive specific events for a specific assembly with a combination of the available criteria.
-
Transformation: message can be transformed before they are sent
-
Dispatching - Message Dispatching: configure to use synchronous or asynchronous mechanism for dispatching event messages.</dd>
You can select multiple notification sinks to similar targets with different filters to achieve the desired verbosity and message frequence.
Type-specific configuration and usage is explained in the the sink specific sections:
- Notifications to URL
- Notifications to Concord
- Notifications to Amazon SNS
- Notifications to Jabber
- Notifications to Slack
Notifications to URL
Notifications can be configured to use a custom URL as notification sink.
In preparation you need to create a web application that receives notifications on a specific URL.
Then follow these steps to configure and use a URL notification sink.
-
Create a new notification sink with the type
account.notification.url.sink. -
Configure the Endpoint URL of the server in the Endpoint section.
-
If the URL is protected from anonymous posts, provide Service Username and Service Password in the Credentials section.
-
Save the new notification sink.
Notifications to Concord
The workflow orchestration system Concord is an example of a system that can be configured as a URL sink to receive notifications from OneOps.
The Endpoint URL needs to be configured to use the oneops event endpoint of
the Concord API e.g. at https://concord.example.com/api/v1/events/oneops.
Typically credentials are required and need to be configured with a service username and password.
To enable Concord triggers for compute replacements filtering is setup with:
- Event Type set to Deployment
- Severity Level set to All
- NS Path to / to send events for all assemblies in the org
- Include Ci enabled with the class patterns bom.Compute, bom.oneops.1.Compute and bom.main.2.Compute to capture all computes
- Include Ci on Replace enabled
This allows a Concord project to configure a trigger that can react to the replace compute events in OneOps by calling a workflow. This can for example be used to run an Ansible playbook against a replaced compute.
Notifications to Amazon SNS
Notifications can be configured to use the Amazon Simple Notification Service as a notification sink.
In preparation you need to create an Amazon SNS account and an access key. Then follow these steps to configure and use an SNS notification sink.
-
Create a new notification sink with the type
account.notification.sns.sink. -
Provide your SNS credentials in Credentials section including the Access Key and the Secret Key.
-
Save the new notification sink.
-
Go to the SNS section in the Amazon AWS console.
-
The first notification event creates an SNS topic for that environment. Subsequent notifications are posted to the same topic.
-
Subscribe to the topic with your email or distribution list.
Notifications to Jabber
Notifications can be configured to use the open XMPP messaging standard originally introduced by Jabber as notification sink.
In preparation you need to get access details for the XMPP/Jabber server. Then follow these steps to configure and use an SNS notification sink.
-
Create a new notification sink with the type
account.notification.jabber.sink. - Configure the connection to the XMPP/Jabber server in Settings section.
- Chat Server - hostname of the chat server.
- Chat Server Port - TCP port of the chat server.
- Conferences Identifier - identifier for the chat conference to receive the notifications.
- User Account - account to authenticate to the server and use to post the notifications.
- User Password - password of the user account.
- Save the new notification sink.
Notifications to Slack
Notifications can be configured to use Slack channels as a notification sink.
Slack Administrator Setup
In preparation an administrator needs to create a custom bot user for each Slack team that wants to receive notifications:
- Create a new custom bot user. If you are currently logged into Slack in your browser, try this link.
- Select the Slack team that will receive the notifications.
- Choose a username for your bot - e.g. oneopsbot
- Click the Add Bot Integration button
- Update other settings for the bot user as desired.
- Note down the API Token for the configuration in OneOPs.
In addition you need to configure the Slack integration in the OneOps notification service called Antenna by setting the environment variables for the Tomcat server running Antenna:
slack.url: The URL to reach the Slack chat service. Defaults to
https://slack.com. You need to ensure that this host can be reached on the
network. In an open deployment on the internet this is already the case. If
OneOps runs in an isolated network you need to open up the network or introduce
a reverse proxy server that can forward requests between Antenna and Slack. One
option for such a reverse proxy server is
NGINX.
slack.tokens: The Slack bot API tokens need to be provided to Antenna with
this configuration. The supported syntax is a comma separated list of all your
bot user tokens for each team like team1=<token1>,team2=<token2>.
Assuming your OneOps installation is managed and run by OneOps itself you can configure those environment variables for Antenna with the OneOps user interface:
- Locate the assembly for OneOps core
- Inspect the Design and locate the Antenna platform in the platforms list on the right
- Click on the Antenna platform
- Click on the Tomcat component in the list of components on the right
- Press the Edit button
- Locate Environment Variables and add
slack.urlandslack.tokensas required - Press the Save button
If OneOps is running via a manual install and is not managed by OneOps itself you have to configure the environment variables in the startup scripts for the Tomcat instance running Antenna.
Slack User Configuration
With the administrator setup completed you can create your Slack notification sinks:
-
Create a new notification sink with the type
account.notification.slack.sink. -
Add the desired Channels to receive notifications in the Slack Config section.
-
Optionally configure Text Formats for inserting additional texts into the message based on detected text. E.g., setting the Key field to
criticaland Value to:fire: ${text}results in the Fire emoji to be inserted before any occurrence ofcritical. -
If desired, enable Include Notification Fields.
-
Save the new notification sink.
-
Ensure that the Slack bot user has access to the channel. For public channels, this is automatically the case. For private channels the bot user needs to be added to the channel users.
