Skip to main content

Settings

Network​

Each network in Invariant is a series of snapshots of one of your networks. Using networks is how you will organize networks either by environment, location, status, or other factors.

Adding a new network​

  1. Navigate to Settings in the top nav bar.
  2. Scroll to the Networks section.
  3. Click Add Network alt text
  4. Provide a network name and description.
  5. Click Create Network. alt text

Notification groups​

Notification Groups are how you set up email alerts when violations happen in networks. You create a group which contains 1 or more emails that are monitoring one or more networks. Your Notification Groups emails and networks can overlap between groups.

Adding a new notification group​

  1. Navigate to Settings in the top nav bar.
  2. Scroll to the Notification Groups section.
  3. Click Add Notification Group alt text
  4. Fill in the notification group name. alt text
  5. Click Add Email.
  6. Fill in an email address. alt text
  7. Click Save
  8. Tick any network box you wish to subscribe the email to. alt text
  9. Provide a description.
  10. Click Create Notification Group

Github repositories​

You can integrate Github with Invariant so that pushes to a snapshot repository are automatically validated by Invariant. This is done via our official Github application. Once you set a repository, you will need to set up a monitor target.

Adding a Github repository​

  1. Navigate to Settings in the top nav bar.
  2. Scroll to the Github Repositories section. alt text
  3. Click Connect a Github Repository.... This will bring you to Github's website where you may have to authenticate.
  4. Click on the account you wish to install Invariant on. alt text
  5. Find the Repository access section and select the repository you wish to monitor. alt text
  6. Click Save
  7. Navigate back to Invariant's Settings and check the Github Repositories section. It may take a minute for everything to update.

Monitor targets​

Monitor targets tell Invariant which repository and path should be monitored and used as the basis for a snapshot. You must have set up a Github Repository prior to using a monitoring target.

Adding a monitoring target​

  1. Navigate to Settings in the top nav bar.

  2. Scroll to the Monitor Targets section.

  3. Click Add Monitor Target. alt text

  4. Fill in the Monitor Target Name.

  5. Select a Github Repository from the drop down menu.

  6. If the snapshot is not at the root of the repository, provide the path to the snapshot.

  7. Select the Network that the snapshots will be uploaded to.

  8. Provide a description of this monitor target. alt text

API token​

API keys are useful for creating automation via our client or SDK. Your API key will appear once, ensure you copy it to a secure place such as a secret store.

Adding a new API token​

  1. Navigate to Settings in the top nav bar.
  2. Scroll to the API Tokens section. alt text
  3. Click Create API Token
  4. Provide a Token Name and Description alt text
  5. Click Create API Token
  6. Copy the API Token to a secure location such as a secret store. You will not get another chance to copy the token once the box is closed.