AustraliaREFERENCE GUIDE

Kubernetes discovery using patterns

ServiceNow documentation·33 min readView source ↗

On this page

Kubernetes discovery using patterns

The ServiceNow ITOM Visibility finds Kubernetes and OpenShift components using patterns and creates application services containing them. Discovery also finds Kubernetes events and frequently updates the CMDB to reflect the dynamic Kubernetes environment.

Discovery uses the Kubernetes pattern and its extension sections to discover Kubernetes components:

The Collect OpenShift info extension section of the Kubernetes pattern discovers the OpenShift components of the Kubernetes deployment. The OpenShift Build Config extension section is available from Store version 1.0.53.
The Service Mesh extension discovers service mesh details. This information enables the pattern to create service-to-service relations, shown as Connects to::Connected. Service mesh discovery requires deploying Istio on your K8s (Kubernetes) cluster. The Service Mesh extension section is available from Kubernetes extension classes. It’s supported on the ServiceNow AI Platform using the Madrid release or later.
The Collect Container Repository and extension section finds container registries and images in these registries.

Starting from Discovery and Service Mapping Patterns version 1.35.0, the Kubernetes Cluster - Per-Namespace LP pattern is available for large cluster discovery. For more information, see the Large-payload Kubernetes discovery section.

In addition, Discovery uses the Kubernetes Event pattern to discover events for Kubernetes components.

Starting from the 1.0.68 release on ServiceNow Store, Service Mapping can use CI relationships to add the Kubernetes components to application services during tag-based discovery.

Discovery uses the following patterns to discover the entire Kubernetes infrastructure deployed on GCP, AWS, and Azure:

Google Cloud Platform (GCP) – Get Kubernetes Clusters.
Amazon AWS Cloud - Get Kubernetes Clusters.
Microsoft Azure - Get Kubernetes Clusters.

These patterns query the Cloud, collect data on all Kubernetes clusters, and create a serverless schedule for each cluster. When the cluster is deleted, the schedule is marked as inactive. This feature eliminates the overhead of creating and managing multiple credentials and serverless discovery schedules per cluster. The Cloud infrastructure patterns are triggered through standard Cloud discovery.

Starting with Discovery and Service Mapping Patterns version 1.31.0, you can choose to discover Docker image CIs only, without discovering Docker container CIs. Check your entitlements to determine whether you have access to 2026 Packaging SKU. For more information, see Disable Docker container CI discovery.

Supported versions

For the list of Kubernetes distribution versions validated against the Kubernetes and Kubernetes Event patterns, see Kubernetes Versions Tested with ServiceNow Discovery [KB3145280].

Request apps on the Store

Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Large-payload Kubernetes discovery

By default, Discovery uses the Kubernetes pattern to discover an entire cluster in a single execution. On large clusters, this can result in incomplete discovery data in the CMDB. The Kubernetes Cluster - Per-Namespace LP pattern is available as an alternative for large cluster environments, starting from Discovery and Service Mapping Patterns version 1.35.0.

The Kubernetes Cluster - Per-Namespace LP pattern identifies the cluster and then discovers each namespace separately, improving reliability on large clusters. The data collected and the CIs populated in the CMDB are identical between the two patterns. For configuration on on-premises clusters, see the Prerequisites for on-premises Kubernetes discovery section. For cloud clusters, see the prerequisites section for your cloud provider.

General prerequisites for Kubernetes discovery

Note: For additional prerequisites for Kubernetes Cloud infrastructure discovery, see below.

Note: Running automatic serverless Kubernetes schedules fetches the Bearer token. Adding credentials is unnecessary.

Perform the following steps so that Discovery can use the pattern to successfully find Kubernetes.

Deploy the latest Discovery and Service Mapping Patterns application from ServiceNow Store.
On the Kubernetes platform, find the parameters to set up Kubernetes discovery:
- Find the URL of the kubeapi server:
  1. On the Kubernetes platform, run the following command:
  2. On the Kubernetes platform, run the following command:
- Find the URL of the kubeapi server:
  1. On the Kubernetes platform, run the following command:
    
    kubectl cluster-info
  2. In the output, find the line that states the URL of the kubeapi server. For example, Kubernetes control plane is running at
    
    https://10.154.144.146:443
- Find the namespaces of the kubeapi server:
  1. On the Kubernetes platform, run this command:
    
    kubectl get namespaces
  2. In the output, find the line that states the namespaces. For example, kube-system.
- Find the Kubernetes username and password:
  1. On the Kubernetes platform, run this command:
    
    kubectl config view
  2. In the output, find the username and password.[Omitted image "kubernetes-username-password.png"] Alt text: Locate the lines that contain information on password and username.
    
    Note: If in a certain environment, kubectl config view command is not showing the expected details, use the supported command from the Kubernetes admin to fetch the user name and password details.
- Find the valid Bearer token with the proper permissions:
  - If you know the default token name, use the command in the following format: kubectl describe secret <default-token-token name>.
    
    For example: kubectl describe secret default-token-g6pwc.
  - If you don't know the default token name, use the command: kubectl describe secret.
Verify that the API Server is reachable from the MID Server for successful Kubernetes discovery.
Verify that the user configured on the Kubernetes platform has GET permissions to run the following /api/v1 elements:
- https://<url>/api/v1/namespaces/
- https://<url>/api/v1/namespaces/<namespace>
- https://<url>/api/v1/namespaces/kube-system/endpoints/kube-controller-manager
- https://<url>/api/v1/services
- https://<url>/api/v1/pods
- https://<url>/api/v1/nodes
- https://<url>/api/v1/replicationcontrollers
- https://<url>/apis/networking.k8s.io/v1/ingresses
- https://<url>/apis/apps/v1/deployments
- https://<url>/apis/apps/v1/statefulsets
- https://<url>/apis/apps/v1/daemonsets
- https://<url>/apis/apps/v1/replicasets
- https://<url>/apis/batch/v1/cronjobs
- https://<url>/apis/batch/v1/jobs Note: When using the Kubernetes Cluster - Per-Namespace LP pattern, verify your RBAC setup before switching. The LP pattern requires the same permissions listed above, but lists resources per namespace instead of cluster-wide. A ClusterRole with a ClusterRoleBinding covers all namespaces automatically and requires no changes. If you use namespace-scoped Role and RoleBinding objects, verify that a binding exists in each namespace that discovery will enumerate, because missing bindings could cause incomplete discovery for that namespace.
To discover the OpenShift components of the Kubernetes deployment, verify that the user configured on the Kubernetes platform has GET permissions to run the following /api/v1 elements:
- /apis/apps.openshift.io/v1/deploymentconfigs
- /apis/build.openshift.io/v1/buildconfigs
- /apis/route.openshift.io/v1/routes
- /apis/user.openshift.io/v1/groups
- /apis/user.openshift.io/v1/users
- /apis/project.openshift.io/v1/projects
- /apis/image.openshift.io/v1/images
- /apis/image.openshift.io/v1/imagestreams To discover service mesh information:
- Deploy Istio on your K8s cluster.
- Provide the Prometheus URL.
- Configure Prometheus to scrape metrics from Istio.
Activate Get Kubernetes Config Files extension to:
- Discover configuration files.
- Create tracked configuration files.
- Map the configuration files workloads and services with a relationship. Note: Tracked files content is in the JSON format from version 1.0.92. Tracked files content is in YAML format in version 1.0.91 and earlier.
Create the Kubernetes credentials on the ServiceNow platform:
1. On the ServiceNow AI Platform, navigate to All > Discovery > Credentials.
2. Select New.
3. Select Kubernetes Credentials.
4. On the form, fill in the fields.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name

</td><td>

Unique and descriptive name for this credential.

</td></tr><tr><td>

User name

</td><td>

User name associated with this credential. Leading or trailing spaces should be avoided; if any are detected, a warning will appear. Only one authentication method should be used: either a user name and password or a Bearer token. Don’t use both.

</td></tr><tr><td>

Password

</td><td>

Password associated with this credential. Only one authentication method should be used: either a user name and password or a Bearer token. Don’t use both.

</td></tr><tr><td>

Bearer Token Authentication

</td><td>

This option enables advanced authentication using a Bearer token. When the check box is selected, the Bearer Token field is displayed.

</td></tr><tr><td>

Bearer Token

</td><td>

Discovery uses the Bearer token for advanced authentication when accessing Kubernetes. The Bearer token should be in BASE64 encoded format, using the character sequence as the token. For example: 31ada4fd-adec-460c-809a-9e56ceb75269.

Only one authentication method should be used: either a user name and password or a Bearer token. Don’t use both.

</td></tr><tr><td>

Credential alias

</td><td>

An alias is configured to use the Kubernetes credential for devices and applications other than Kubernetes. This alias is also used when defining a serverless discovery schedule for discovering the Kubernetes deployment.1. Select the padlock icon, and then select the search icon. 2. On the Connection & Credential Aliases form, select New. 3. Specify a name for the credential alias record. 4. Define attributes for the alias. Set the Type to Credential. 5. Select and hold (or right-click) the form header and select Save, then select Update. 6. On the Connection & Credential Aliases form, select the newly added alias.

The alias appears in the Credential alias field.

</td></tr></tbody> </table> 5. On the Kubernetes credentials form, select Update. 8. Create a serverless discovery schedule for the Kubernetes pattern. 1. Navigate to All > Discovery > Discovery Schedules and select New. 2. On the form, fill in the fields.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name

</td><td>

Unique name for this discovery schedule.

</td></tr><tr><td>

Discover

</td><td>

Scan type, which should be Serverless.

</td></tr><tr><td>

MID Server selection method

</td><td>

Select the method that Discovery uses to select a MID Server:- Specific MID Cluster: Use a preconfigured cluster of MID Servers. The MID Server can’t be part of multiple clusters - Specific MID Server: Use only one MID Server. If that MID Server is part of a cluster, only that MID Server is used. The cluster isn’t used.

</td></tr><tr><td>

MID server

</td><td>

Name of the MID Server to use for this schedule. This field is available if MID Server selection method is set to Specific MID Server.

</td></tr><tr><td>

MID Server cluster

</td><td>

Name of the MID Server cluster to use for this schedule. This field is available if MID Server selection method is set to Specific MID Cluster.

</td></tr></tbody> </table> 3. Select Submit. 4. In the Execution Patterns related list, select New. 5. On the form, fill in the fields.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name

</td><td>

Descriptive name for this record.

</td></tr><tr><td>

Pattern

</td><td>

Pattern to use for this schedule: - Kubernetes - Kubernetes Cluster - Per-Namespace LP (starting from Discovery and Service Mapping Patterns version 1.35.0)

</td></tr><tr><td>

Run Child Patterns

</td><td>

Enable this option if you selected Kubernetes Cluster - Per-Namespace LP as the pattern.

</td></tr></tbody> </table> 6. Select Submit. 7. In the Pattern Launcher Parameters related list, configure the parameters.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

url

</td><td>

The identifier for the hostname, IP, or FQDN and the port of the Kubernetes apiserver. Use the following format: example_hostname:example_port or example_ip:example_port. Provide the correct protocol (HTTP or HTTPS) in the URL.

</td></tr><tr><td>

namespace

</td><td>

The namespaces that the system passes in the Kubernetes Discovery Configuration. Enter one of the following values:- Individual namespace: enter the namespace and then “kube-system”. For example: dev,kube-system - The default value: enter default, kube-system - Multiple namespaces: enter the namespaces, use a comma (,) to separate the values, and then enter “kube-system”. For example: automation,application,test,kube-system - All namespaces: Use an asterisk (*) to enter all namespaces

</td></tr><tr><td>

credentials alias

</td><td>

The alias associated with the previously created Kubernetes credentials.

</td></tr><tr><td>

cluster name

</td><td>

The name of the Kubernetes cluster, in the following format: <serviceaccountid><space><clustername>.

</td></tr><tr><td>

provider

</td><td>

The cloud provider or deployment type: - For cloud hosted clusters: GCP, AWS, or Azure - For on-premises clusters: OnPrem

</td></tr><tr><td>

cluster_resource_id

</td><td>

Cluster resource ID example:- Azure Kubernetes clusters - Resource ID. - AWS - cluster ARN. - GCP - cluster global name.

</td></tr><tr><td>

cluster_uid_cache

</td><td>

Internal parameter used by the Kubernetes Cluster - Per-Namespace LP pattern. Leave this value empty.

</td></tr></tbody> </table>9. Create a serverless discovery schedule for the Kubernetes Event pattern. Configure the schedule to run every 5 or 10 minutes.

**Note:** When the pattern is run for the first time, it stores an event\_timestamp. Later on it collects only the delta events based on the timestamp. The more often the pattern is run, the fewer updates to the CMDB IRE are needed.

Create a serverless execution pattern for the discovery schedule and assign it to the Kubernetes Events pattern. Configure the parameters required by the Kubernetes pattern as described in [Configuring execution pattern attributes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery/kubernetes-discovery.md).

To include discovered components into service instances, enable CI relationships used in tag-based discovery by Service Mapping. These CI relationships are available from the 1.0.68 release on the ServiceNow Store. For operational steps, see Tag-based discovery configuration.

Additional prerequisites for Kubernetes Cloud infrastructure discovery

For the Google Cloud Platform (GCP) – Get Kubernetes Clusters pattern, perform the following:

In the ServiceNow instance, set up a Google Cloud Platform (GCP) service account with valid credentials and permissions.
On the GCP infrastructure, set up the MID Server with full access to all Cloud APIs: Set Cloud API access scopes to "Allow full access to all Cloud APIs". The MID Server instance can access only the Clusters specific to the project.
Navigate to sys_properties.list and, using the admin role, configure the following properties:
- sn_itom_pattern.k8s_midserver: Specify a valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).
- sn_itom_pattern.k8s_midserver: Specify a valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).
  
  Note: To target a specific service account or cluster, you can configure the sn_itom_pattern.k8s_<service_account_id>_midserver and the sn_itom_pattern.k8s_<service_account_id>_<clustername>_midserver properties. The most specific property takes precedence.
- sn_itom_pattern.k8s_create_schedule_enabled: Set the value to true.
  
  Note: Enabling the sn_itom_pattern.k8s_create_schedule_enabled property automatically creates a serverless schedule for your cloud clusters, eliminating the need for manual scheduling. If you have an existing manual schedule and want to convert it to an automatic one, enable the property. Your manual schedule will be updated; no additional schedule will be created. An automatically created schedule has no “Max run time” defined.
- sn_itom_pattern.k8s_entry_pattern: To use the per-namespace large-payload (LP) discovery pattern, set the value to Kubernetes Cluster - Per-Namespace LP (starting from Discovery and Service Mapping Patterns version 1.35.0).
Create and run Google Cloud Discovery

Note:

To fetch the Bearer token, while running GKE Kubernetes schedule, use the gcloud command:

gcloud config config-helper --format="value(credential.access_token)"

Configuring gcloud in the MID Server instance grants access to the GKE cluster to fetch the token.

For the Amazon Elastic Kubernetes Service (EKS) cluster discovery, perform the following:

In the ServiceNow instance, set an AWS service account with valid management account credentials and permissions.
1. Verify that the Amazon Elastic Kubernetes Service (EKS) Cluster has a cluster role with the read-only access to all resources.
2. Create cluster role binding between the cluster role and a Kubernetes user. For example, read-onlyuser.
3. Create an AWS IAM role with the policy EKSReadOnly.
4. Associate the IAM role with the Kubernetes user in one of the following ways:
  - In the cluster, edit the aws-auth ConfigMap.
  - Run the command:
  - In the cluster, edit the aws-auth ConfigMap.
  - Run the command:
5. Verify that the Amazon Elastic Kubernetes Service (EKS) Cluster has a cluster role with the read-only access to all resources.
6. Create cluster role binding between the cluster role and a Kubernetes user. For example, read-onlyuser.
7. Create an AWS IAM role with the policy EKSReadOnly.
8. Associate the IAM role with the Kubernetes user in one of the following ways:
  - In the cluster, edit the aws-auth ConfigMap.
  - Run the command:
    
    eksctl create iamidentitymapping --cluster yourClusterName --arnarn:aws:iam::yourAccountID:role/yourIAMRoleName --username read-only-user
Run Amazon Elastic Kubernetes Service (EKS) cluster discovery in one of two ways: Using the AWS Command Line Interface (CLI) or without using the AWS CLI. First, set the system property sn_itom_pattern.k8s_aws_cli_to_generate_token to use the model you choose. This system property is set to true by default.
- Set this system property to true to use AWS CLI to generate a token.
- Set this system property to false to use Assume Roles to generate a token.
- Run Amazon Elastic Kubernetes Service (EKS) cluster discovery using AWS CLI:
  1. Set up the MID Server with the AWS CLI configured. Configuring AWS CLI credentials grants access to the Amazon Elastic Kubernetes Service (EKS) cluster.
    
    Note: The user logged in to the system must be the same as the MID Server user.
  2. To generate the Bearer token, While running the Amazon Elastic Kubernetes Service (EKS) schedule, use the AWS CLI command:aws eks get-token --cluster-name <cluster_name>.
    
    Configuring the AWS CLI user/role in the MID Server instance grants access to the Amazon Elastic Kubernetes Service (EKS) cluster to generate the token.
- Run Amazon Elastic Kubernetes Service (EKS) cluster discovery without using AWS CLI:
  
  Note:
  
  This feature is supported from Discovery and Service Mapping Patterns version 1.0.96 - December 2022.
  
  Refer to the following KB for detailed instructions: KB1182188: EKS cluster discovery using STS AssumeRoles (Without AWS CLI)
Navigate to sys_properties.list and, using the admin role, configure the following properties:
- sn_itom_pattern.k8s_midserver: Specify a valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).
  
  Note: To target a specific service account or cluster, you can configure the sn_itom_pattern.k8s_<service_account_id>_midserver and the sn_itom_pattern.k8s_<service_account_id>_<clustername>_midserver properties. The most specific property takes precedence.
- sn_itom_pattern.k8s_create_schedule_enabled: Set the value to true.
  
  Note: Enabling the sn_itom_pattern.k8s_create_schedule_enabled property automatically creates a serverless schedule for your cloud clusters, eliminating the need for manual scheduling. If you have an existing manual schedule and want to convert it to an automatic one, enable the property. Your manual schedule will be updated; no additional schedule will be created. An automatically created schedule has no “Max run time” defined.
- sn_itom_pattern.k8s_entry_pattern: To use the per-namespace large-payload (LP) discovery pattern, set the value to Kubernetes Cluster - Per-Namespace LP (starting from Discovery and Service Mapping Patterns version 1.35.0).
Create and run an AWS Cloud Discovery schedule.

For Microsoft Azure Kubernetes Services (AKS)- Kubernetes cluster discovery, perform the following:

Update to the latest Discovery and Service Mapping Patterns version.
In the ServiceNow instance, configure the Azure Service Account with valid Azure credentials and permission.
Navigate to sys_properties.list and, using the admin role, configure the following properties:
- sn_itom_pattern.k8s_midserver: Specify a valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).
- sn_itom_pattern.k8s_midserver: Specify a valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).
  
  Note: To target a specific service account or cluster, you can configure the sn_itom_pattern.k8s_<service_account_id>_midserver and the sn_itom_pattern.k8s_<service_account_id>_<clustername>_midserver properties. The most specific property takes precedence.
- sn_itom_pattern.k8s_create_schedule_enabled: Set the value to true.
  
  Note: Enabling the sn_itom_pattern.k8s_create_schedule_enabled property automatically creates a serverless schedule for your cloud clusters, eliminating the need for manual scheduling. If you have an existing manual schedule and want to convert it to an automatic one, enable the property. Your manual schedule will be updated; no additional schedule will be created. An automatically created schedule has no “Max run time” defined.
  
  .
- sn_itom_pattern.k8s_entry_pattern: To use the per-namespace large-payload (LP) discovery pattern, set the value to Kubernetes Cluster - Per-Namespace LP (starting from Discovery and Service Mapping Patterns version 1.35.0).
If you don't have local accounts with Kubernetes RBAC and want to improve pattern efficiency, navigate to MID Server > Properties and set the sn_itom_pattern.aks_fetch_local_ad_token property to false.
Run an Azure cloud discovery schedule.
Configure the MID Server in the Discovery schedules according to the cluster account type. If you don't have Local accounts with RBAC, you can ignore this step.

Cluster account type

</th><th>

Discovery schedule MID Server

</th></tr></thead><tbody><tr><td>

MS Entra ID auth with Kubernetes RBAC.

</td><td>

Any MID Server.

</td></tr><tr><td>

MS Entra ID authentication with Azure RBAC.

</td><td>

Any MID Server.

</td></tr><tr><td>

Local accounts with Kubernetes RBAC.

</td><td>

Select the MID Server with the Azure Command Line Interface (CLI) configured. Configuring the Azure CLI credentials grants access to the AKS cluster.

To fetch the Bearer token while running the AKS Kubernetes schedule, use the Azure CLI command: az aks get-credentials --name <cluster_name> --overwrite-existing --resource-group <resourceGroup_name> --file -.

</td></tr></tbody> </table> Note:

-   The user logged in to the system must be the same as the MID Server user.
-   For detailed information about AKS Cluster Discovery configuration, see the [AKS Cluster Discovery Configuration Details \[KB1220553\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1220553) article in the Now Support Knowledge Base.

</th><th>

Property name

</th><th>

Property description

</th><th>

Type

</th><th>

Default value

</th></tr></thead><tbody><tr><td>

</td><td>

sn_itom_pattern.manifest_digest_image_id

</td><td>

Boolean

</td><td>

false

Note: Before setting this property to true and running discovery: avoid duplicate records from being created by deleting all Docker image records.

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_create_schedule_enabled

</td><td>

The feature flag that can be enabled/disabled under the system properties, which is responsible to control the pattern execution. When enabled, it creates discovery schedules despite the new property value. An automatically created schedule has no “Max run time” defined.

</td><td>

Boolean

</td><td>

false

</td></tr><tr><td>

</td><td>

sn_itom_k8s_run_cloud_discovery

</td><td>

When enabled, this property executes cloud Kubernetes patterns, discovering Kubernetes clusters without creating auto schedules.

</td><td>

Boolean

</td><td>

false

</td></tr><tr><td rowspan=“5”>

MID Server

</td><td>

sn_itom_pattern.k8s_midserver*

</td><td>

[Default]

Example- Valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0). Applies to newly created discovery schedules only; existing schedules aren’t updated.

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_midserver*

</td><td>

[Based on Service Account Level]

Example- Valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_<clustername>_midserver*

</td><td>

[Based on Cluster name]

Example- Valid MID Server or MID Server cluster name (MID Server cluster support starting with Discovery and Service Mapping Patterns version 1.35.0).

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.kubernetes_collect_volume

</td><td>

When the property is set to True, the data for Kubernetes Volume [cmdb_ci_kubernetes_volume] gets populated.

</td><td>

String

</td><td>

false

</td></tr><tr><td>

sn_itom_pattern.k8s_add_workload_to_image_relation

</td><td>

Starting from Discovery and Service Mapping Patterns version 1.30.2, the Kubernetes patterns create an indirect-only relationship between Docker Image and workload CIs through Kubernetes Pods. Setting the property to true also creates direct relationships between Docker Image and the following workload CI types: Deployment, DaemonSet, ReplicaSet, StatefulSet, and ReplicationController.

</td><td>

Boolean

</td><td>

false

</td></tr><tr><td rowspan=“3”>

Credential Alias

</td><td>

sn_itom_pattern.k8s_ cred_alias

</td><td>

[Default]

Example- credential alias name

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_alias

</td><td>

[Based on Service Account Level]

Example- Valid credential alias name.

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_<clustername>_alias

</td><td>

[Based on Cluster name]

Example- Valid credential alias name.

</td><td>

String

</td><td>

</td></tr><tr><td rowspan=“3”>

Prometheus Url

</td><td>

sn_itom_pattern.k8s_ prometheusUrl

</td><td>

[Default]

Example- Valid Prometheus Url

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_prometheusUrl

</td><td>

[Based on Service Account Level]

Example- Valid Prometheus Url

</td><td>

String

</td><td>

</td></tr><tr><td>

sn_itom_pattern.k8s_<service_account_id>_<clustername>_prometheusUrl

</td><td>

[Based on Cluster name]

Example- Valid Prometheus URL

</td><td>

String

</td><td>

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_ run

</td><td>

[Supported Discovery Schedule run- Daily, On Demand, Weekdays, Weekends, Month Last Day, Calendar Quarter End]

Example- Daily

</td><td>

String

</td><td>

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_batch_count

</td><td>

[Refers how many schedules to run in batch – default set to 5]

Example- 5 (Number of schedules to run in on batch)

</td><td>

Integer

</td><td>

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_schedule_batch_delay

</td><td>

[keeps tracks of the time difference between two batches value contains in sec]

Example- 300 (in seconds)

</td><td>

Integer

</td><td>

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_run_time

</td><td>

[keeps tracks of the current time for a batch]

If this property is set, then you can use the same or you can use the dynamic timing, which will be 5 min after the system current timing. Values contains in HH:MM:SS format

Example- 10:11:12 (HH:MM:SS )

</td><td>

String

</td><td>

</td></tr><tr><td>

</td><td>

sn_itom_pattern.bring_discovery_container

</td><td>

Available starting with Discovery and Service Mapping Patterns version 1.31.0. This property controls whether the Kubernetes, Kubernetes Event, Docker Pattern, and Amazon AWS - ECS patterns discover both Docker container and Docker image CIs, or only Docker image CIs. Check your entitlements to determine whether you have access to 2026 Packaging SKU.

</td><td>

Boolean

</td><td>

true

</td></tr><tr><td>

</td><td>

sn_itom_pattern.k8s_entry_pattern

</td><td>

Controls which entry pattern Kubernetes cloud discovery uses. When set to Kubernetes Cluster - Per-Namespace LP, discovery identifies the cluster and then discovers each namespace separately, improving reliability on large clusters. The Kubernetes Cluster - Per-Namespace LP pattern is available starting from Discovery and Service Mapping Patterns version 1.35.0.

</td><td>

String

</td><td>

Kubernetes

</td></tr></tbody> </table>* If a MID Server and a MID Server cluster share the same name, the MID Server cluster takes precedence. sn_itom_pattern.k8s_<service_account_id>_midserver takes precedence over sn_itom_pattern.k8s_midserver for that account. sn_itom_pattern.k8s_<service_account_id>_<clustername>_midserver takes precedence over both for that account and cluster.

Note: <service_account_id> is the account ID name under Cloud Service Accounts. For more information, see: Create Discovery schedules for cloud resources

Kubernetes Credential-less or mid-in-cluster discovery

Prerequisites for Kubernetes Credentials-less discovery:

Deploy the containerized MID Server to the Kubernetes cluster. Configuring Kubernetes credentials is unnecessary since the MID Server in Kubernetes cluster automatically discovers the API server and authenticate.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

URL

</td><td>

Enter any one the of following value in URL field:

cluster

kubernetes.default.svc

</td></tr><tr><td>

namespace

</td><td>

The namespaces that the system passes in the Kubernetes Discovery Configuration. Enter one of the following values:

Individual namespace: enter the namespace and then “kube-system”. For example: dev,kube-system
The default value. Enter:default,kube-system
Multipile namespaces: enter the namespaces, use a comma (,) to separate the values, and then enter “kube-system”. For example: automation,application,test,kube-system
All namespaces: Use an asterisk (*) to enter all namespaces.

</td></tr><tr><td>

cluster_name

</td><td>

Enter Unique name.

</td></tr></tbody> </table>## Data collected by Discovery during horizontal discovery

Kubernetes pattern
Field Description Name [name] The name of the kube-controller-manager leader. Kubernetes UID [k8s_uid] The kube-system namespace UID [supported versions: 1.0.92 and later] IP Address [ip_address] The identifier for the host IP of the Kubernetes apiserver. Port [port] The identifier for the Kubernetes apiserver port. Namespace [namespace] This value shows the namespaces the system passed in the Kubernetes Discovery Configuration. Event Timestamp [event_timestamp] The timestamp of the latest event created on this Kubernetes cluster at the time of the discovery. Field Description The virtual aspect of the Kubernetes node. Data relating to the physical aspect of the Kubernetes node is stored under Linux server. Name [name] The name of the Kubernetes node. The format can be only the name of the machine or the full name consisting of the name and the hostname: <name>.<hostname>. Kubernetes UID [k8s_uid] The identifier for the Kubernetes node UUID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Operational status [operational_status] The operational status of the Kubernetes node. Field Description Name [name] The name of the Kubernetes service. Selector [selector] A comma delimited list of the label selectors specified in the Kubernetes configuration that are used to select target pods. Namespace [namespace] The Kubernetes namespace to which this Kubernetes service belongs. Kubernetes UID [k8s_uid] The Kubernetes service UUID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Field Description Name [name] The name of the Kubernetes pod. Kubernetes UID [k8s_uid] The Kubernetes pod UUID. Resource version [resource_version] The resource version of the Kubernetes pod. Namespace [namespace] The Kubernetes namespace to which this Kubernetes pod belongs. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. State [state] The Kubernetes pod status: Pending, Running, Succeeded, Failed, and Unknown. Field Description Name [name] The name of the Kubernetes cronjob. Namespace [namespace] The Kubernetes namespace to which this Kubernetes cronjob belongs. Kubernetes UID [k8s_uid] The Kubernetes cronjob UUID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Field Description Name [name] The name of the Kubernetes job. Namespace [namespace] The Kubernetes namespace to which this Kubernetes job belongs. Kubernetes UID [k8s_uid] The Kubernetes job UUID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Field Description Name [name] The name of the Kubernetes daemonset. Namespace [namespace] The Kubernetes namespace to which this Kubernetes daemonset belongs. Kubernetes UID [k8s_uid] The Kubernetes daemonset UUID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Pods Available [pods_avail] The number of available pods. Pods Failed [pods_failed] The number of pods in the Failed phase. Pods Running [pods_running] The number of pods in the Running phase. Pods Succeeded [pods_succeeded] The number of pods in the Succeeded phase. Pods Waiting [pods_waiting] The number of pods in the Waiting phase. Field Description Name [name] The name of the Kubernetes ingress. Namespace [namespace] The Kubernetes namespace to which this Kubernetes ingress belongs. Kubernetes UID [k8s_uid] The Kubernetes ingress UID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Field Description Name [name] The name of the Kubernetes deployment. Namespace [namespace] The Kubernetes namespace to which this Kubernetes deployment belongs. Kubernetes UID [k8s_uid] The Kubernetes deployment UID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Total Replicas [total_replicas] The number of replicas in this deployment. Desired Replicas [desired_replicas] The number of replicas in the desired phase. Available Replicas [available_replicas] The number of available replicas. Unavailable Replicas [unavailable_replicas] The number of replicas in the unavailable phase. Updated Replicas [updated_replicas] The number of updated replicas. Field Description Name [name] The name of the Kubernetes replicaset. Namespace [namespace] The Kubernetes namespace to which this Kubernetes replicaset belongs. Kubernetes UID [k8s_uid] The Kubernetes replicaset UID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Total Replicas [total_replicas] The number of replicas in this replicaset. Desired Replicas [desired_replicas] The number of replicas in the desired phase. Available Replicas [available_replicas] The number of available replicas. Unavailable Replicas [unavailable_replicas] The number of replicas in the unavailable phase. Updated Replicas [updated_replicas] The number of updated replicas. Field Description Name [name] The name of the Kubernetes replication controller. Namespace [namespace] The Kubernetes namespace to which this Kubernetes replication controller belongs. Kubernetes UID [k8s_uid] The Kubernetes replication controller UID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Total Replicas [total_replicas] The number of replicas in this replication controller. Desired Replicas [desired_replicas] The number of replicas in the desired phase. Available Replicas [available_replicas] The number of available replicas. Unavailable Replicas [unavailable_replicas] The number of replicas in the unavailable phase. Updated Replicas [updated_replicas] The number of updated replicas. Field Description Name [name] The name of the Kubernetes statefulset. Namespace [namespace] The Kubernetes namespace to which this Kubernetes statefulset belongs. Kubernetes UID [k8s_uid] The Kubernetes statefulset UID. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Total Replicas [total_replicas] The number of replicas in this statefulset. Desired Replicas [desired_replicas] The number of replicas in the desired phase. Available Replicas [available_replicas] The number of available replicas. Unavailable Replicas [unavailable_replicas] The number of replicas in the unavailable phase. Updated Replicas [updated_replicas] The number of updated replicas.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td colspan=“2”>

The component that runs the docker image.

</td></tr><tr><td>

Container id [container_id]

</td><td>

The unique identifier for the Kubernetes docker container.In cases where duplicate records are created, deduplication tasks appear once discovery runs. For information on how to resolve these tasks, see the Making docker container identifier independent [KB1443042] article in the ServiceNow® Knowledge Base.

|Field|Description|
|-----|-----------|
|The server that hosts the Kubernetes node.|
|Name \[name\]|The name of the Linux server powering the Kubernetes node.|
|Host name \[host\_name\]|The hostname of the Linux server.|
|Operating System \[os\]|The operating system deployed on this Linux server.|
|Kernel Release \[kernel\_release\]|The version of the Linux kernel operating system deployed on this Linux server.|
|RAM \(MB\) \[ram\]|The size of RAM installed on this Linux server.|
|IP Address \[ip\_address\]|The IP address of the Linux server.|
|CPU type \[cpu\_type\]|The CPU architecture of the Linux server hosting the Kubernetes node.|
|CPU count \[cpu\_count\]|The number of CPUs on the Linux server hosting the Kubernetes node.|
|Serial number \[serial\_number\]|The serial number of the Linux server hosting the Kubernetes node.|

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td colspan=“2”>

This configuration item contains Kubernetes labels. Labels are key/value pairs that are attached to objects, such as pods.

</td></tr><tr><td>

Key [key]

</td><td>

The key of the Kubernetes pod or Kubernetes service Key Value parameter.

</td></tr><tr><td>

Value [value]

</td><td>

The value of the Kubernetes pod or Kubernetes service Key Value parameter.

</td></tr><tr><td>

Configuration item [configuration_item]

</td><td>

References one of the following CI tables, based on the key-value pair: - Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] - Kubernetes Deployment [cmdb_ci_kubernetes_deployment] - Kubernetes Ingress [cmdb_ci_kubernetes_ingress] - Kubernetes Namespace [cmdb_ci_kubernetes_namespace] - Kubernetes Node [cmdb_ci_kubernetes_node] - Kubernetes Pod [cmdb_ci_kubernetes_pod] - Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] - Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] - Kubernetes Service [cmdb_ci_kubernetes_service] - Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset]

|Field|Description|
|-----|-----------|
|Name \[name\]|The name of the Kubernetes namespace.|
|Kubernetes Cluster \[cluster\]|References the Kubernetes Cluster \[cmdb\_ci\_kubernetes\_cluster\] table.|
|State \[state\]|The Kubernetes namespace phase: Active or Terminating.|

Collect OpenShift info pattern extension
Field Description Name [name] The name of the OpenShift deployment configuration. Namespace [namespace] The name of the namespace containing the deployment configuration. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Url [url] The URL of the OpenShift deployed configuration, available only for Kubernetes versions earlier than 1.16. Field Description Name [name] The name of the OpenShift build configuration. Namespace [namespace] The name of the OpenShift namespace containing the build configuration. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift build configuration, available only for Kubernetes versions earlier than 1.16. Field Description Name [name] The name of the OpenShift source image. To [to] Related image. Parent ID [parent_id] The ID of the OpenShift source image. Field Description Name [name] The name of the OpenShift route. Namespace [namespace] The name of the namespace containing the OpenShift route. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Kubernetes Cluster [cluster] References the Kubernetes Cluster [cmdb_ci_kubernetes_cluster] table. Url [url] The URL of the OpenShift route, available only for Kubernetes versions earlier than 1.16. Host [host] The target host of the OpenShift route. Port [port] The target port of the OpenShift route. Field Description Name [name] The name of the OpenShift group. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift group, available only for Kubernetes versions earlier than 1.16. Field Description Name [name] The name of the OpenShift user. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift user, available only for Kubernetes versions earlier than 1.16. Full Name [full_name] The full name of the OpenShift user. Field Description Name [name] The name of the OpenShift project. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift project, available only for Kubernetes versions earlier than 1.16. Field Description Name [name] The name of the OpenShift image. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift image, available only for Kubernetes versions earlier than 1.16. Docker Image Metadata ID [docker_image_metadata_id] The ID of the docker image. Docker Image Metadata Parent ID [docker_image_metadata_parent_id] The ID of the image parent. Architecture [arch] The architecture of the image. Size [size] The image size. Hostname [hostname] The hostname related to the image. Field Description Name [name] The name of the OpenShift image stream. Kubernetes UID [k8s_uid] The Kubernetes UID of this resource. Url [url] The URL of the OpenShift image stream, available only for Kubernetes versions earlier than 1.16. Namespace [namespace] The name of the namespace containing the OpenShift image stream. Field Description Name [name] The name of the OpenShift docker image repository. Parent ID [parent_id] The ID of the parent system.

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td colspan=“2”>

This configuration item contains OpenShift labels. Labels are key/value pairs that are attached to objects, such as deployed configurations and routes.

</td></tr><tr><td>

Key [key]

</td><td>

The key of the OpenShift deployed configuration or route Key Value parameter.

</td></tr><tr><td>

Value [value]

</td><td>

The value of the OpenShift deployed configuration or route Key Value parameter.

</td></tr><tr><td>

Configuration item [configuration_item]

</td><td>

References one of the following CI tables, based on the key-value pair: - OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] - OpenShift Route [cmdb_ci_openshift_route]

</td></tr></tbody> </table>- Collect Container Repository pattern extension

|Field|Description|
|-----|-----------|
|Name \[name\]|The name of the container repository.|

|Field|Description|
|-----|-----------|
|Name \[name\]|The name of the container repository entry.|
|Category \[category\]|The category of the container repository entry.|

Kubernetes deployment diagrams

The graphic illustrates CIs that are part of Kubernetes discovery.

Note: This Dependency Views map was simplified for clarity. Your Kubernetes deployments may contain many more CIs.

[Omitted image “kubernetes-diagram.png”] Alt text: Relationships between Kubernetes configuration items and Kubernetes workload tables

[Omitted image “openshift-diagram.png”] Alt text: Namespace contains OpenShift configuration items

CI relationships and references created by the Kubernetes pattern

These relationships and references are created by the Kubernetes pattern. References link to records in other tables and don’t appear in the CI Relationship [cmdb_rel_ci] table.

CI Relationship CI Docker Container [cmdb_ci_docker_container] Runs on::Runs Linux Server [cmdb_ci_linux_server]* Docker Image [cmdb_ci_docker_image] Instantiates::Instantiated by Docker Container [cmdb_ci_docker_container]* Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by Kubernetes Ingress [cmdb_ci_kubernetes_ingress] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Cluster of::Cluster Kubernetes Node [cmdb_ci_kubernetes_node]* Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by Kubernetes Pod [cmdb_ci_kubernetes_pod]* Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by Kubernetes Service [cmdb_ci_kubernetes_service]* Kubernetes Cronjob [cmdb_ci_kubernetes_cronjob] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes Cronjob [cmdb_ci_kubernetes_cronjob] Owns::Owned by Kubernetes Job [cmdb_ci_kubernetes_job] Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] Instantiates::Instantiated by Docker Image [cmdb_ci_docker_image] Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Instantiates::Instantiated by Docker Image [cmdb_ci_docker_image] Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Owns::Owned by Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Owns::Owned by Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] Kubernetes Ingress [cmdb_ci_kubernetes_ingress] Instantiates::Instantiated by Kubernetes Service [cmdb_ci_kubernetes_service] Kubernetes Job [cmdb_ci_kubernetes_job] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes Job [cmdb_ci_kubernetes_job] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes Cronjob [cmdb_ci_kubernetes_cronjob] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes Ingress [cmdb_ci_kubernetes_ingress] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes Job [cmdb_ci_kubernetes_job] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes Service [cmdb_ci_kubernetes_service] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset] Kubernetes Node [cmdb_ci_kubernetes_node] Hosted on::Hosts Linux Server [cmdb_ci_linux_server]* Kubernetes Pod [cmdb_ci_kubernetes_pod] Contains::Contained by Docker Container [cmdb_ci_docker_container]* Kubernetes Pod [cmdb_ci_kubernetes_pod] Contains::Contained by Docker Image [cmdb_ci_docker_image]* Kubernetes Pod [cmdb_ci_kubernetes_pod] Contains::Contained by Kubernetes Volume [cmdb_ci_kubernetes_volume]* Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] Instantiates::Instantiated by Docker Image [cmdb_ci_docker_image] Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] Instantiates::Instantiated by Docker Image [cmdb_ci_docker_image] Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Kubernetes Service [cmdb_ci_kubernetes_service] Provided By::Provides Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset] Kubernetes Service [cmdb_ci_kubernetes_service] Provided By::Provides Kubernetes Deployment [cmdb_ci_kubernetes_deployment] Kubernetes Service [cmdb_ci_kubernetes_service] Provided By::Provides Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset] Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset] Hosted on::Hosts Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset] Instantiates::Instantiated by Docker Image [cmdb_ci_docker_image] Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset] Instantiates::Instantiated by Kubernetes Pod [cmdb_ci_kubernetes_pod] Linux Server [cmdb_ci_linux_server] Contains::Contained by Kubernetes Pod [cmdb_ci_kubernetes_pod]* Linux Server [cmdb_ci_linux_server] Managed by::Manages Kubernetes Cluster [cmdb_ci_kubernetes_cluster]*

* These relationships are also created by the Kubernetes Event pattern.

</th><th>

Field

</th><th>

Referenced CI

</th></tr></thead><tbody><tr><td>

Container Environment Variables [cmdb_container_environment_variables]

</td><td>

Configuration item [configuration_item]

</td><td>

Docker Container [cmdb_ci_docker_container]

</td></tr><tr><td>

Key Value [cmdb_key_value]

</td><td>

Configuration item [configuration_item]

</td><td>

References one of the following CI tables, based on the key-value pair:

Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset]
Kubernetes Deployment [cmdb_ci_kubernetes_deployment]
Kubernetes Ingress [cmdb_ci_kubernetes_ingress]
Kubernetes Namespace [cmdb_ci_kubernetes_namespace]
Kubernetes Node [cmdb_ci_kubernetes_node]
Kubernetes Pod [cmdb_ci_kubernetes_pod]
Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset]
Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller]
Kubernetes Service [cmdb_ci_kubernetes_service]
Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset]

</td></tr><tr><td>

Kubernetes Cronjob [cmdb_ci_kubernetes_cronjob]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes DaemonSet [cmdb_ci_kubernetes_daemonset]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Deployment [cmdb_ci_kubernetes_deployment]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Ingress [cmdb_ci_kubernetes_ingress]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Job [cmdb_ci_kubernetes_job]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Namespace [cmdb_ci_kubernetes_namespace]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Node [cmdb_ci_kubernetes_node]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Pod [cmdb_ci_kubernetes_pod]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Service [cmdb_ci_kubernetes_service]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes StatefulSet [cmdb_ci_kubernetes_statefulset]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Kubernetes Volume [cmdb_ci_kubernetes_volume]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

Serial Number [cmdb_serial_number]

</td><td>

Configuration Item [cmdb_ci]

</td><td>

Linux Server [cmdb_ci_linux_server]

</td></tr></tbody> </table>## CI relationships created by the Kubernetes cloud patterns

These additional relationships are created by the Google Cloud Platform (GCP) – Get Kubernetes Clusters, Amazon AWS Cloud - Get Kubernetes Clusters, and Microsoft Azure - Get Kubernetes Clusters patterns.

CI Relationship CI Azure Datacenter [cmdb_ci_azure_datacenter] Hosted on::Hosts Cloud Service Account [cmdb_ci_cloud_service_account] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Hosted on::Hosts Azure Datacenter [cmdb_ci_azure_datacenter] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Hosted on::Hosts Google Datacenter [cmdb_ci_google_datacenter] Resource Group [cmdb_ci_resource_group] Contains::Contained by Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

CI relationships and references created by the Kubernetes extension sections

The following extension sections of the Kubernetes pattern identify additional relationships and references. References link to records in other tables and don’t appear in the CI Relationship [cmdb_rel_ci] table.

Collect OpenShift info
CI Relationship CI Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift Docker Image Repository [cmdb_ci_openshift_docker_images_repository] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift Group [cmdb_ci_openshift_group] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift Image [cmdb_ci_openshift_images] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift Project [cmdb_ci_openshift_project] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift Source2Image [cmdb_ci_openshift_source_2_image] Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Contains::Contained by OpenShift User [cmdb_ci_openshift_user] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by OpenShift Build Config [cmdb_ci_openshift_build_conf] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by OpenShift Image Stream [cmdb_ci_openshift_images_stream] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained by OpenShift Route [cmdb_ci_openshift_route] Kubernetes Service [cmdb_ci_kubernetes_service] Provided By::Provides OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] OpenShift Build Config [cmdb_ci_openshift_build_conf] Contains::Contained by Tracked Configuration file [cmdb_ci_config_file_tracked] OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] Contains::Contained by Tracked Configuration file [cmdb_ci_config_file_tracked] OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] Owns::Owned by Kubernetes ReplicaSet [cmdb_ci_kubernetes_replicaset] OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] Owns::Owned by Kubernetes ReplicationController [cmdb_ci_kubernetes_replicationcontroller]

</th><th>

Field

</th><th>

Referenced CI

</th></tr></thead><tbody><tr><td>

Key Value [cmdb_key_value]

</td><td>

Configuration item [configuration_item]

</td><td>

References one of the following CI tables, based on the key-value pair:- OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] - OpenShift Route [cmdb_ci_openshift_route]

</td></tr><tr><td>

OpenShift Deployed Config [cmdb_ci_openshift_dep_conf]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr><tr><td>

OpenShift Route [cmdb_ci_openshift_route]

</td><td>

Kubernetes Cluster [cluster]

</td><td>

Kubernetes Cluster [cmdb_ci_kubernetes_cluster]

</td></tr></tbody> </table>- Collect Container Repository

|CI|Relationship|CI|
|---|------------|---|
|Docker Image \[cmdb\_ci\_docker\_image\]|Provisioned From::Provisioned|Container Repository Entry \[cmdb\_ci\_container\_repository\_entry\]|
|Container Repository Entry \[cmdb\_ci\_container\_repository\_entry\]|Hosted on::Hosts|Container Repository \[cmdb\_ci\_container\_repository\]|

Istio Service Mesh

Prerequisites for Istio Service Mesh extension:
- Verify that Istio Service Mesh and Prometheus components are configured on the Kubernetes cluster.
- Verify that Prometheus discovers the service connection information using the queryistio_requests_total command.
- Verify that the application services are connected, and verify service-to-service traffic flow in Kiali graph. For more information on the Bookinfo application, see: https://istio.io/latest/docs/examples/bookinfo/
CI Relationship CI Kubernetes Service [cmdb_ci_kubernetes_servi ce] Connects to::Connected by Kubernetes Service [cmdb_ci_kubernetes_servi ce]

Data collected by Service Mapping during tag-based discovery

Service Mapping uses tag-based discovery to create application service maps including the Kubernetes components. Service Mapping comes with the following preconfigured CI relationships used for tag-based discovery. These CI relationships are available from the 1.0.68 release on ServiceNow Store.

CI Relationship CI Kubernetes Service [cmdb_ci_kubernetes_service] Contained By::Contains Kubernetes Cluster [cmdb_ci_kubernetes_cluster] OpenShift Project [cmdb_ci_openshift_project] Contained by::Contains Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes Pod [cmdb_ci_kubernetes_pod] Contained by::Contains Kubernetes Cluster [cmdb_ci_kubernetes_cluster] Kubernetes Pod [cmdb_ci_kubernetes_pod] Cluster::Cluster of Kubernetes Service [cmdb_ci_kubernetes_service] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained By OpenShift Deployed Config [cmdb_ci_openshift_dep_conf] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained By OpenShift Build Config [cmdb_ci_openshift_build_conf] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained By OpenShift Route [cmdb_ci_openshift_route] Kubernetes Namespace [cmdb_ci_kubernetes_namespace] Contains::Contained By OpenShift Image Stream [cmdb_ci_openshift_images_stream]

Kubernetes dashboard

After Discovery finishes discovering components of the Kubernetes deployment, you can navigate to Workspaces > Discovery Admin Workspace > Insights and use the Kubernetes Explorer dashboard to view the Kubernetes environments and resources of your organization. To use the enhanced Kubernetes dashboard, verify you have Discovery Admin Workspace starting from version 1.3.1 (August 2024 Store). For more information about Kubernetes Explorer, see Kubernetes Explorer.

Troubleshooting

If the mapping process does not proceed as you expected, follow the following suggestions.

Symptom

</th><th>

Cause

</th><th>

Solution

</th></tr></thead><tbody><tr><td>

Discovery fails. The discovery message contains the information about an error caused by the REST timeout.

</td><td>

There are many CIs sending the REST call response in the deployment. The MID Server cannot process the REST call response without exceeding the time limit controlled by the mid.sa.cloud.request_timeout parameter.

</td><td>

By default, the mid.sa.cloud.request_timeout parameter is set to 30000 milliseconds. Increase the value of this parameter on the relevant MID Server and run discovery again.

Note: If the Configuration Parameters related list for the relevant MID Server does not show this parameter, you may need to add it.

</td></tr><tr><td>

Pattern Designer fails during a debug session. The Pattern Designer message contains information about an error caused by a timeout.

</td><td>

The Pattern Designer fails because of a timeout during pattern debugging (and not during discovery).

</td><td>

By default, the sa.debugger.max_timeoutparameter is set to 240 seconds.Increase the value of this parameter on the relevant MID Server.

</td></tr></tbody> </table>To run the Kubernetes pattern in Debug mode, refer to KB0832567 for operational information.

Container image scanning for software decomposition
The ITOM Visibility apps, Discovery and Service Mapping Patterns and Kubernetes Visibility Agent integrate with Aqua Trivy to collect data on container images and OS packages. You can increase your control over container deployment by having visibility to the container components.

Parent Topic:Discovery for containerized resources

Keep exploring.

Find another answer, or bring this documentation into your own tools.

Search the library →Read via the REST API ↗