Labels
The management of labels in the Kentik portal is discussed in the following topics:
About Labels
A high-level explanation of labels in the Kentik portal is provided in the following topics:
Labels Overview
A label in Kentik enables you to create a collection of items that can be treated as a group. You can specify a value (text) for the label property on any Kentik-registered data source listed on the Devices Page, though not on the cloud data sources on the Public Clouds page. Labels may also be applied to synthetic tests (see About Synthetics), ksynth agents (see Kentik Synthetics Agents), credentials, dashboards, and saved views (see Applying Labels). The items in a group would typically be (but are not required to be) alike in some way; the label simply allows you to refer to them all together rather than individually. Labels are not mutually exclusive, so any item to which a label can be applied may have more than one label.
Labels are particularly useful for determining which network devices will be included in a query. If a query’s devices are referenced via a label rather than directly, the devices whose flow data is actually included when the query is run are determined at run time based on which devices have that label. This means that you can later change the devices included in the underlying query of a given component — e.g. dashboard, saved view, report, or saved filter — by changing the devices to which the label is applied rather than revising the component itself.
Notes:
- Labels may also be used to restrict access to certain parts of the portal (see Using Labels with RBAC).
- The devices, agents, and tests that have a given label at the run time of a query are treated by that query as if they have had that label for the query’s entire time range.
Applying Labels
The portal location in which a label can be applied to or removed from an item depends on the type of that item:
- Agents: Label a Synthetics Agent and Remove Synthetics Agent Labels using:
- Label controls above the Agents List.
- Settings in a Configure Agent Dialog.
- Alert Policies: Label an Alert Policy and Remove Policy Labels using:
- Selected Policy Controls above the Policies List (all policies).
- Settings on Policy Settings Pages (all policy types except NMS). - Credentials: Label a Credential and Remove Credential Labels using settings in the Credential Settings Dialogs.
- Dashboards: Label a Dashboard and Remove Dashboard Labels using Selected Item Controls above the Library List.
- Devices: Label a Device and Remove Device Labels using:
- Label Controls above the Device List.
- Settings in the Device Settings Dialog. - Saved Views: Label a Saved View and Remove Saved View Labels using:
- Selected Item Controls above the Library List.
- Settings in the Saved View Dialogs. - Synthetic Tests: Label a Synthetics Test and Remove Synthetics Test Labels using:
- Label Controls above the Tests List.
- Settings on theTest Information tab, on a Test Settings Page.
Label Appearance
Throughout the Kentik portal, an item’s labels are shown almost everywhere that item’s details are displayed, filtered, or set (e.g. in lists, on Details panes, etc.):
- In general UI, a label displays as a gray rounded rectangle with a user-selected stripe of color down its left side.
- In a label settings field, an X is included to the right of the label text. Click the X to remove the label from the set of labels applied with the field.
Labels Page
Labels are managed from the Labels List on the Labels page, which you get to from the Settings page by clicking Labels under Network Metadata. The Labels page is covered in the following topics:
Note: While a Member-level user can access this page to see your organization's existing labels, you must be an Administrator-level user to add, modify, delete, or remove a label.
Labels Page UI
The Labels page includes the following UI elements:
- Add Label controls: Buttons and fields that you use to add a label (see Add Label Controls).
- Show/Hide Filters (funnel icon): A button to the left of the Search bar that toggles the display of the Filters pane.
- Search: A field that displays current usage filters and also allows you to search existing labels using a text string.
- Filters: A pane with which you can filter the Labels list (see Label Filters Pane).
- Labels list: A table listing your organization’s currently defined labels (see Labels List).
Labels List
The Labels list is a table that lists all of your organization’s existing labels. Click on a column heading to sort the list (ascending or descending). Each row of the table corresponds to one label and provides the information and options covered in the topics below.
Label Information Columns
The following information columns are displayed to users of all levels:
- Label: The designated color and name of the label.
- Usage: The numbers of devices, agents, tests, policies, saved views, or dashboards to which the label has been assigned.
Label Admin Actions
The following actions (far-right column) are available only to Administrator-level users:
- Edit Label (pencil icon): A button that opens an Edit Label Dialog that allows you to change the label’s color or name.
- Remove (trash icon): A button that opens a confirming dialog that allows you to remove the label from your organization.
Add Label Controls
The Add Label controls (at the top right of the page) enable Administrator-level users to add a new label to their organization’s collection of labels:
- Color (swatch): A button that opens a popup color selector from which you can choose a color to associate with the label (default is gray).
- Name: A field in which to enter a name for the new label.
- Add Label (active only when text is present in the Name field): A button that adds a new label with the specified name and color. The new label will be added to the Labels list.
Label Filters Pane
The Filters pane to the left of the Labels list includes the following controls to manage filtering of the labels that appear in the list:
- Clear all (present only when one or more filters are specified): A button that clears all current filters.
- Usage: Checkboxes that correspond to the types of items to which a label may be applied (agent, device, alert policy, synthetic test, dashboard, or saved view). Only items of the selected type(s) will be shown in the Labels list.
The following rules govern how the filter controls affect the Labels list:
- If no criteria are selected, the list includes all of your organization's existing labels.
- If one or more Usage checkboxes are checked, the list will include all labels that have been applied to any items of the selected types. If a label hasn't been applied to any items of the selected types, it will not appear in the list.
- If text is entered in the Search field and one or more of the checkboxes are checked, the list will include only labels that match both criteria.
Edit Label Dialog
The Edit Label dialog, which opens from the Edit button at the right of each row of the Labels List, enables you to change the properties of a label:
- Color selector: A swatch that displays the label's current color. Click to open a popup color selector from which you can change the color.
- Name: An editable field that displays the label’s name.
- Cancel: A control -- either the X at top right or the button along the bottom -- that exits the dialog without saving any changes to settings.
- Save: A button that saves the current settings and exits the dialog.
Manage Labels
The management of labels is covered in the following topics:
Add a Label
To add a new label to your organization’s collection of labels:
- Open the Labels page (Settings » Labels).
- In the Add Labels section at the top of the page, specify the following:
- Label color: Click the color swatch to set a color for the label.
- Label name: Enter a name string in the field. - Click the Add Label button. The label will be added to the Labels list.
Edit a Label
To edit the name or color of an existing label:
- Open the Labels page (Settings » Labels).
- In the Labels List, find the label that you'd like to modify.
- Click the Edit button at the right of the label's row. In the resulting Edit Label Dialog, modify the label using the name field and/or color swatch.
- Click the Save button to save changes.
Remove a Label
To remove an existing label from your organization's collection of labels:
- Open the Labels page (Settings » Labels).
- In the Labels List, find the label that you'd like to remove.
- Click the Remove button. In the resulting dialog:
- Click the Remove Label button to remove the label.
- Click the Cancel button to close the dialog without removing the label.
Apply and Remove Labels
The following topics cover the procedures for applying labels to and removing labels from multiple types of items throughout the Kentik portal:
- Label a Device
- Remove Device Labels
- Label a Synthetics Test
- Remove Synthetics Test Labels
- Label an Alert Policy
- Remove Policy Labels
- Label a Credential
- Remove Credential Labels
- Label a Dashboard
- Remove Dashboard Labels
- Label a Saved View
- Remove Saved View Labels
- Label a Synthetics Agent
- Remove Synthetics Agent Labels
- Using Labels with RBAC
Notes:
- The UI for labels on devices is covered in Label Controls.
- For information on using labels for ksynth agents, see Agents List Labels.
Label a Device
A label may be applied to a device in the following locations:
- The Device List on the Devices page (for multiple devices simultaneously).
- A Device Settings dialog when adding or editing an individual device.
Label Devices on Devices Page
To apply an existing label to one or more devices:
- Open the Devices page (Settings » Network Devices).
- In the Device list, click the checkbox at the left of each device that you'd like to label. The Apply Labels field will show the labels, if any, that are already applied to any selected device.
- Click the Apply Labels field to drop down a filterable list of all existing labels in your organization (see Label Controls).
- In the list, the labels (if any) that are already applied to any selected device will be highlighted.
- If the label you wish to apply is not highlighted, click the label once to apply it to all selected devices.
- If the label you wish to apply is highlighted, click the label twice. The first click will remove the label from any selected devices on which it is currently applied, and the second click will apply the label to all selected devices. - Click outside the drop-down to close it. The labels will appear under the device name in the Name column of the Device list.
Label Devices in Device Dialog
To apply an existing label to an individual device using a Device dialog:
- From the Devices page (Settings » Network Devices), do one of the following to open a Device dialog:
- New device: Click the Add Device button to add a new device as described in Add a Device.
- Existing device: In the Device list, click the Edit button in the row for the device that you'd like to edit. - In the General tab of the Device dialog, any labels that are already applied to the device will appear in the Labels field.
- Click the Labels field to drop down a filterable list of the labels in your organization. In the list, the labels (if any) that are already applied to the device will be highlighted.
- Find and select the labels you’d like to apply to the device.
- Complete setting up the device if you’re adding a new one.
- Do one of the following to save the applied labels to the device and return to the Devices page:
- New device: Continue specifying all of the other settings of the device, then click the Add Device button.
- Existing device: Click the Save button.
Remove Device Labels
Removing a label from a device is possible from both the Devices page and a Device dialog.
Remove Labels on Devices Page
To remove a label from one or more devices:
- Open the Devices page (Settings » Network Devices).
- In the Device list, click the checkbox at the left of each device from which you'd like to remove a given label. The Apply Labels field will show each label that is applied to one or more of the devices.
- Click the X at the right of any label in the Apply Labels field that you'd like to remove from all of the currently checked tests, or click the Clear Labels button to remove all labels from those tests.
Remove Labels in Device Dialog
To remove a label from an individual device using the Device dialog:
- Open the Devices page (Settings » Network Devices).
- In the Device list, on the right side of the row for the device from which you'd like to remove a label, click the Edit button.
- In the Device dialog, on the General tab, in the Label(s) field, click the X at the right of a lozenge to remove it.
- Click Save to save your changes and close the dialog.
Label a Synthetics Test
A label may be applied to a synthetic test in one of the following locations:
- The Tests list on the Test Control Center landing page.
- A Test Settings Page when adding or editing an individual test.
Label Test in the Tests List
To apply an existing label to one or more tests:
- Open the Test Control Center page (select Test Control Center from the main menu).
- In the Tests list, click the checkbox at the left of each test that you'd like to label. The Apply Labels field will show the labels, if any, that are already applied to any selected test.
- Click the Apply Labels field to drop down a filterable list of all existing labels in your organization (see Label Controls).
- In the list, the labels (if any) that are already applied to any selected test will be highlighted.
- If the label you wish to apply is not highlighted, click the label once to apply it to all selected tests.
- If the label you wish to apply is highlighted, click the label twice. The first click will remove the label from any selected tests to which it is currently applied, and the second click will apply the label to all selected tests. - Click outside the drop-down to close it. The labels will appear under the test name in the Name column of the Tests list.
Label a Test in Test Settings
To apply a label to a synthetic test on its settings page:
- Open the Test Control Center page (select Test Control Center on the main menu) and do one of the following:
- New test: Click the Add Test button to add a new test as described in Add a Test.
- Existing test: In the Tests list, find the test to which you'd like to apply a label, then click the Edit button at the right of the test's row. - On the test's Test Settings Page, go to the Test Information tab. On an existing test, the tab's Labels field will show any labels currently applied to the test.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, the labels (if any) that are already applied to the selected test will be highlighted.
- Find and click one or more labels that you’d like to apply to the test. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Do one of the following to save the applied labels to the test and return to the Test Control Center:
- New test: Continue specifying all of the other settings of the test, then click the Create Test button.
- Existing test: Click the Save button.
Note: If the Labels drop-down doesn't include a label that you'd like to apply, you can click Add Label to create a new label. The new label will not be applied automatically to the current test; to apply it you must select it with the Labels field as described above.
Remove Synthetics Test Labels
A label may be removed from synthetic tests in one of the following locations:
- The Tests list on the Test Control Center landing page;
- The Test Settings Page of an individual test.
Remove Labels on Tests List
To remove a label from one or more synthetic tests on the Tests list:
- Open the Test Control Center page (select Test Control Center on the main menu).
- In the Tests list, click the checkbox at the left of each test from which you'd like to remove a given label. The Apply Labels field will show the labels that are applied to one or more of the selected tests.
- Click the X at the right of any label in the Apply Labels field that you'd like to remove from all of the currently checked tests, or click the Clear Labels button to remove all labels from those tests.
Remove Labels in Test Settings
To remove a label from a synthetic test on its Edit Test page:
- Open the Test Control Center page (select Test Control Center on the main menu).
- In the Tests list, find the test from which you'd like to remove a label, then click the Edit button at the right of the test's row.
- On the resulting Edit Test page, go to the Test Information tab. The tab's Labels field will show any labels currently applied to the test.
- Click the X at the right of any labels you'd like to remove.
- Click Save to save your changes to the test and return to the Test Control Center.
Label an Alert Policy
A label may be applied to an alert policy in one of the following locations:
- The Policies List on the Policies page: apply labels to any policy type.
- The Policy Settings page for an individual policy: apply labels to policies whose type is DDoS, Query-Based, or Core.
Label Policy on Policies Page
To apply an existing label to one or more policies on the Policies list:
- Open the Settings page and select Alert Policies.
- In the Policies list, click the checkbox for each policy to which you’d like to apply a label. The Selected Policy Controls will appear above the Policies list. The Apply Labels field will show the labels, if any, that are already applied to any selected policy.
- Click the Apply Labels field to drop down a filterable list of all existing labels in your organization.
- In the list, the labels (if any) that are already applied to any selected policy will be highlighted.
- If the label you wish to apply is not highlighted, click the label once to apply it to all selected policies.
- If the label you wish to apply is highlighted, click the label twice. The first click will remove the label from any selected policies to which it is currently applied, and the second click will apply the label to all selected policies. - Click outside the drop-down to close it. The labels will appear under the policy name in the Name column of the Policies list.
Label Policy in Policy Settings
To apply a label to an alert policy on its settings page:
- From the Alert Policies page (Settings » Alert Policies), do one of the following:
- New policy: Click the Add Policy button to add a new policy as described in Adding a Policy.
- Existing policy: In the Policies list, find the policy to which you'd like to apply a label, then choose Edit Policy from the Policy Action Menu (vertical ellipsis) at the right of the policy's row. - On the policy's settings page (see Policy Settings) go to the General tab. For an existing policy, the tab's Labels field will show any labels currently applied to the policy.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, the labels (if any) that are already applied to the selected policy will be highlighted.
- Find and click one or more labels that you’d like to apply to the policy. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Do one of the following to save the applied labels to the policy and return to the Policies page:
- New policy: Continue specifying all of the other settings of the policy, then click the Save button.
- Existing policy: Click the Save button.
Note: If the Labels drop-down doesn't include a label that you'd like to apply, you can click Add Label to create a new label. The new label will not be applied automatically to the current policy; to apply it you must select it with the Labels field as described above.
Remove Policy Labels
You can remove a policy’s label in the same two places where you can add labels: in the Policies List (on the Policies page), or on an individual Policy Settings page.
Remove Labels on Policies Page
To remove a label from one or more policies on the Policies page:
- Open the Alert Policies page (Settings » Alert Policies).
- In the Policies list, click the checkbox at the left of each policy from which you’d like to remove the label. The Selected Policy Controls will appear above the Policies list. The Apply Labels field will show the labels that are applied to one or more selected policies.
- Click the X at the right of any label in the Apply Labels field that you'd like to remove from all of the currently checked policies, or click the Clear Labels button to remove all labels from those policies.
Remove Labels in Policy Settings
To remove a label from a policy on its Edit Policy page:
- Open the Alert Policies page (Settings » Alert Policies).
- In the Policies list, find the test from which you'd like to remove a label, then choose Edit Policy from the Policy Action Menu (vertical ellipsis) at the right of the policy's row.
- On the policy's settings page (see Policy Settings) go to the General tab. The Labels field will show the labels currently applied to the policy.
- In the Labels field, click the X at the right of a label to remove it.
- Click the Save button to save the policy and return to the Policies page.
Label a Credential
To apply an existing label to a credential:
- Open the Credentials Vault page from the Organization Settings menu.
- In the Credential list, find the credential to which you'd like to apply a label, then click the Edit button at the right of the credential's row.
- In the resulting settings dialog (see Credential Settings Dialogs), the Labels field will show any labels currently applied to the credential.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, any labels that are already applied to the selected credential will be highlighted.
- Find and click one or more labels that you’d like to apply to the credential. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Click Save to save your changes and close the dialog.
Note: If the Labels drop-down doesn't include a label that you'd like to apply, you can click Add Label to create a new label. The new label will not be applied automatically to the current credential; to apply it you must select it with the Labels field as described above.
Remove Credential Labels
To remove a label from a credential:
- Open the Credentials Vault page (Organization Settings » Credentials Vault).
- In the Credential list, find the credential from which you’d like to remove a label, then click the Edit button at the far right of its row.
- In the Edit Credential dialog, the Labels field will show any labels currently applied to the credential. Click the X at the right of any label to remove it.
- Click Save to save your changes and close the dialog.
Label a Dashboard
A label may be applied to a dashboard in the following locations:
- The Library List in the Library (for multiple devices simultaneously).
- A dashboard dialog (see Dashboard Dialogs) when adding or editing an individual dashboard.
Label Items in Library
To apply an existing label to one or more items (dashboards or saved views) in the Library:
- Open the Library (select Library from the main menu).
- In the Library list, click the checkbox for each item to which you’d like to apply a label. The Selected Item Controls will appear above the Library list. The Apply Labels field will show the labels, if any, that are already applied to any selected item.
- Click the Apply Labels field to drop down a filterable list of all existing labels in your organization.
- In the list, the labels (if any) that are already applied to any selected item will be highlighted.
- If the label you wish to apply is not highlighted, click the label once to apply it to all selected items.
- If the label you wish to apply is highlighted, click the label twice. The first click will remove the label from any selected items to which it is currently applied, and the second click will apply the label to all selected items. - Click outside the drop-down to close it. The labels will appear to the right of the item name in the Name column of the Library list.
Label Dashboard in Dashboard Dialog
To apply an existing label to a dashboard using a dashboard dialog (see Dashboard Dialogs):
- Open the Library (select Library from the main menu).
- Open a dashboard dialog:
- New dashboard: Click Add New » Dashboard.
- Existing dashboard: In the Library list, find the dashboard to which you'd like to apply a label, then choose Edit Properties from the Action menu (vertical ellipsis) at the right of the dashboard's row. - In the Dashboard dialog, the Labels field will show any labels currently applied to the dashboard.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, any labels that are already applied to this dashboard will be highlighted.
- Select one or more labels from the filterable drop-down list.
- Find and click one or more labels that you’d like to apply to the dashboard. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Do one of the following to save the applied labels to the dashboard and return to the Library:
- New dashboard: Continue specifying all of the other settings of the dashboard, then click the Add Dashboard button.
- Existing dashboard: Click the Save button.
Note: If the Labels drop-down doesn't include a label that you'd like to apply, you can click Add Label to create a new label. The new label will not be applied automatically to the current policy; to apply it you must select it with the Labels field as described above.
Remove Dashboard Labels
A label may be removed from a dashboard in the following locations:
- The Library List in the Library (for multiple items simultaneously).
- The settings dialog for an individual dashboard (see Dashboard Dialogs).
Remove Labels via Library List
To remove a label from one or more items (dashboards and/or saved views) in the Library list:
- Open the Library (select Library from the main menu).
- In the Library list, click the checkbox at the left of each item from which you'd like to remove a given label. The Apply Labels field will show the labels that are applied to one or more of the selected items.
- Click the X at the right of any label in the Apply Labels field that you'd like to remove from all of the currently checked items, or click the Clear Labels button to remove all labels from those items.
Remove Labels via Library Dialogs
To remove a label from a Library item using its settings dialog:
- Open the Library (select Library from the main menu).
- In the Library list, find the item from which you'd like to remove a label, then choose Edit Properties from the Action menu (vertical ellipsis) at the right of the item's row.
- In the resulting dialog, the Labels field will show any labels currently applied to the item.
- Click the X at the right of any labels you'd like to remove.
- Click Save to save your changes and return to the Library.
Label a Saved View
There are two ways to apply a label to a saved view: in a Saved View dialog or directly on the Library list.
A label may be applied to a saved view in the following locations:
- The Library List in the Library (for multiple devices simultaneously): see Label Items in Library.
- A saved view dialog (see Saved View Dialogs) when adding or editing an individual saved view.
Label Saved View in Dialog
To apply an existing label to an individual saved view using a saved view dialog:
- Open the Library (select Library from the main menu).
- Open a saved view dialog:
- New saved view: Click Add New » Saved View.
- Existing saved view: In the Library list, find the saved view to which you'd like to apply a label, then choose Edit Properties from the Action menu (vertical ellipsis) at the right of the saved view's row. - In the Saved View dialog, the Labels field will show any labels currently applied to the saved view.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, any labels that are already applied to this saved view will be highlighted.
- Select one or more labels from the filterable drop-down list.
- Find and click one or more labels that you’d like to apply to the saved view. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Do one of the following to save the applied labels to the saved view and return to the Library:
- New saved view: Continue specifying all of the other settings of the saved view, then click the Add Saved View button.
- Existing saved view: Click the Save button.
Note: If the Labels drop-down doesn't include a label that you'd like to apply, you can click Add Label to create a new label. The new label will not be applied automatically to the current saved view; to apply it you must select it with the Labels field as described above.
Remove Saved View Labels
A label may be removed from a saved view in the following locations:
- The Library List in the Library (for multiple items simultaneously); see Remove Labels via Library List.
- The saved view dialog (see Saved View Dialogs) for an individual saved view; see Remove Labels via Library Dialogs.
Label a Synthetics Agent
A label may be applied to a Synthetics agent in one of the following locations:
- All agents: The Agents List on the Agent Management page: apply labels to any agent type.
- Private agents only: The Configure Agent Dialog for an individual private agent.
Label Agent in Agents List
To label any existing agent:
- Open the Agent Management page from the portal's main menu.
- On one of the Agents List Tabs, click the checkbox at the left of each agent that you'd like to label. The Apply Labels field will show the labels, if any, that are already applied to any selected agent.
- Click the Apply Labels field to drop down a filterable list of your organization's existing labels (see Label Controls).
- In the list, the labels (if any) that are already applied to any selected agent will be highlighted.
- If the label you wish to apply is not highlighted, click the label once to apply it to all selected agents.
- If the label you wish to apply is highlighted, click the label twice. The first click will remove the label from any selected agents to which it is currently applied, and the second click will apply the label to all selected agents. - Click outside the drop-down to close it. The labels will appear under the agent name in the Name column of the Agents list.
Label a Private Agent
In addition to labeling a private agent on the Private Agents tab, you can also apply a label in its Configure Agent Dialog.
- Open the Agent Management page from the portal's main menu.
- On the Private Agents tab, click the row of the agent to which you’d like to apply a label.
- In the Agent Details Sidebar, click the Configure button to open the Configure Agent dialog. The Labels field will show any labels that have already been applied to the agent.
- Click the Labels field to drop down a filterable list of your organization's labels. In the list, any labels that are already applied to this agent will be highlighted.
- Find and click one or more labels that you’d like to apply to the test. Each selected label will appear in the Labels field. When finished choosing labels, click outside of the drop-down to close the list.
Note: To remove a label that you've added to the field, click the X at its right. - Click Save to save your changes and return to the Agent Management page.
Remove Synthetics Agent Labels
To remove a label from one or more synthetic agents:
- Open the Agent Management page from the portal's main menu.
- In the Agents list, click the checkbox for each agent from which you’d like to remove a label. The Apply Labels field will display all of the labels that are applied to the selected agent(s).
- Click the X at the right of any label in the Apply Labels field that you'd like to remove from all of the currently checked agents, or click the Clear Labels button to remove all labels from those agents.
Using Labels with RBAC
Kentik's Role-based Access Control (RBAC) system grants permissions that control the ability to access an item, such as a portal location, as well as what you can do there. These permissions are enabled/disabled via roles that can be assigned to one or more Kentik users (see About Kentik RBAC).
In some contexts, RBAC is label-aware, meaning that the permissions needed for a given item can be made contingent on a label assigned to that item. For example, a role whose permissions enable access to dashboards in the Library may be configured to apply only to dashboards with a specific label, meaning that users who are assigned that role won't have access to dashboards that don't have that label applied.
Note: This functionality applies only to custom roles and is currently limited to credentials, dashboards, devices, and saved views.
To make a role's permissions contingent on one or more labels:
- From the Organization Settings menu on the main portal navbar, choose Manage RBAC Roles to open the Role-based Access Control (RBAC) page.
- In the Custom Roles section of the Roles list, find the role whose permissions you’d like to modify. If needed, use the Search field above the list to narrow the listed roles.
- Click the Edit button at the right of the role's row to open the Manage RBAC Role page.
- On the Permissions tab, filter the Permissions list to show the permission group corresponding to the focus of the role (e.g. "Dashboards"). Each permission in the group will have an enable/disable switch at left and — if the permission is enabled — an Access drop-down at right that is set by default to "Full Access."
- Enable the permission that you'd like to make label-contingent.
- Click the permission's Access drop-down and select "Label Access." An Add Label drop-down will appear below the permission’s description.
- Click on the Add Label drop-down to show a filterable list of your organization's existing labels, then do one of the following:
- Click on an individual label to apply that label to the permission.
- Use the Search field to filter the list, then click Select All at the right of the field to apply all labels shown in the list. - The applied label(s) will appear to the left of the Add Label drop-down. Repeat the above to apply additional labels to the permission.
- Click Save (top right) to save your changes to the role.
- If you're finished making changes to the role, click Cancel to return to the RBAC landing page.