This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

    Network

    As of June, 2021, the Network Security Policy tool has moved out of Policies and into its own menu item in Sysdig Secure SaaS.

    Network Security Policy Tool

    By default, all pods within a Kubernetes cluster can communicate with each other without any restrictions. Kubernetes Network Policies help you isolate the microservice applications from each other, to limit the blast radius and improve the overall security posture.

    With the Network Security Policy tool, you can author and fine-tune Kubernetes network policies within Sysdig Secure. Use it to generate a “least-privilege” policy to protect your workloads, incorporating both observed network traffic and additional user assessment. It doesn’t introduce any additional firewalls or inline connection proxies, leveraging the functionality that already exists in Kubernetes instead.

    Benefits

    This tool provides deep insight into microservice communications, saves time and effort by automatically describing network policies based on observed traffic, and guides the user to author appropriate policies.

    More specifically, it delivers:

    • Out-of-the-box visibility into network traffic between applications and services, with a visual topology map to help identify communications.

    • A baseline network policy that you can directly refine and modify to match your desired declarative state.

    • Automated KNP generation based on the network communication baseline + user-defined adjustments.

    • Least-privilege: KNPs follow an allow-only model, any communication that is not explicitly allowed will be forbidden

    • Enforcement delegated to the Kubernetes control plane, avoiding additional instrumentation or directly tampering with the host’s network configuration

    Prerequisites

    Sysdig agent version 10.7+

    Supported Orchestrator Distributions and CNI Plugins:

    • Vanilla Kubernetes (kops, kube-admin) using Calico, Weave, or cillium

    • OpenShift 4.x using OVS

    • Google GKE using Calico, Weave, or cillium

    • Amazon EKS using Calico, Weave, or cillium

    • Rancher Kubernetes using Calico, Weave, or cillium

    • Azure using Calico CNI

    Using the Network Security Policy Tool

    To use the Network Security Policy tool, follow these basic steps:

    1. Ensure your environment meets the Prerequisites.

    2. Log in to Sysdig Secure and select Network. You will be prompted to select a cluster and namespace, then taken to the Network Security Policies page.

    3. Set up the scope. (Which entities over which time periods should be analyzed?)

    4. Review the Ingress/Egress tables and edit the detected communications as desired.

    5. Review everything visually in the Topography Map.

    6. Click Generated Policy and download the resulting file.

    7. Optional: Fine-tune the tool configuration.

    Set the Scope

    You first define the Kubernetes entity and timeframe for which you want to aggregate communications.

    Understanding the aggregation: Communications are aggregated using Kubernetes metadata to avoid having additional entries that are not relevant for the policy creation. For example, if pod A under deployment A communicates several times with pod B under deployment B, only one entry appears in the interface. Or: If pod A1 and pod A2, both under deployment A, both communicate with pod B, deployment A will represent all its pods.

    1. In the Sysdig Secure UI, select Network from the left menu.

    2. Choose Cluster and Namespace from the drop-down menus.

    3. Select the type of Kubernetes entity for which you want to create a policy:

      • Service

      • Deployment

      • Daemonset

      • Stateful Set

      • CronJob Choose CronJob to see communication aggregated to the CronJob (scheduler) level, rather than the Job, which may generate an excess number of entries.

      • Job Choose Job to see entries where a Job has no CronJob parent.

    4. Select the timespan, i.e. how far back in time to aggregate the observed communications for the entity. The interface will display the Ingress / Egress tables for that Kubernetes entity and timeframe.

    Manage Ingress and Egress

    The ingress/egress tables detail the observed communications for the selected entity (pod owner) and time period.

    Granular and global assignments: You can then cherry-pick rows to include/exclude from the policy granularly, or establish general rules using the drop-down global rule options.

    **Understanding unresolved IPs:**For some communications, it may not be possible to resolve one of the endpoints to Kubernetes metadata and classify as Service, Deployment, etc.. For example, if a microservice is communicating with an external web server, that external IP is not associated with any Kubernetes metadata in your cluster. The UI will still display these entities as “unresolved IPs.” Unresolved IPs are excluded by default from the Kubernetes network policy, but can be added manually via the ingress/egress interface.

    Choose Ingress or Egress to review and edit the detected communications:

    1. Select the scope as described above.

    2. For in-cluster entities: Edit the permitted communications as desired, by either:

      • Selecting/deselecting rows of allowed communication, or

      • Choosing General Ingress/Egress Rules: Block All, Allow All Inside Namespace, or Allow All.

    3. For unresolved IPs (if applicable): If the tool detects many unresolved IPs, you can:

      • Search results by any text to locate particular listings

      • Filter results by

        • Internal: found within the cluster

        • External: found outside the cluster

        • Aliased: displays any given alias

        • Unknown: unable to tell if internal or external.

      • Fine-tune the handling of unknown IPs (admins only) .

        You can assign an alias, set the IP to “allowed” status, or add a CIDR configuration so the IP so the IP is correctly categorized and labelled.

    4. Repeat on the other table, then proceed to check the topology and/or generate the policy.

    Use Topology Visualization

    Use the Topology view to visually validate if this is the policy you want, or if something should be changed. The topology view is a high-level Kubernetes metadata view: pod owners, listening ports, services, and labels.

    Communications that will not be allowed if you decide to apply this policy are color-coded red.

    Pop-up detail panes: Hover over elements in the topology to see all the relevant details for both entities and communications.

    Review and Download Generated Policy

    When you are satisfied with the rules and communication lines, simply click the Generated Policy tab to get an instantaneously generated file.

    Review the resulting YAML file and download it to your browser.

    Configuration Fine-Tuning

    Sysdig has introduced a Configuration panel for Administrators who want to fine-tune the way the agent pre-processes the network data.

    It contains three areas, described below:

    • Workload labels

    • Unresolved IPs

    • Cluster CIDR configurations

    To access:

    1. Log in to Sysdig Secure as administrator.

    2. Select Network from the left navigation.

    3. Click the Configuration button on the upper right.

    Workload Labels

    The Sysdig agent automatically detects the labels used for entities in a cluster. Sometimes, there are many more labels than are needed for network security purposes. In these cases, you can select the two or three most meaningful labels and use include/exclude to avoid clutter in both the UI and your network security policies.

    Unresolved IP Configuration

    If the Sysdig agent cannot resolve an IP to a higher-level structure (Service, Deployment, Daemonset, etc.) it will be displayed as “unresolved” in the ingress/egress tables.

    You can now manually enter such IPs or CIDRs in the configuration panel, label them with an alias, and optionally set them to “allowed” status. Note that grouping IPs under a single alias helps declutter the Topography view.

    Cluster CIDR Configuration

    Unresolved IPs are listed and categorized as “internal” (inside the cluster), “external” (outside the cluster) or “unknown,” (subnet information incomplete). For unknowns, Sysdig will prompt with an error message to help you resolve it (see ??? ).

    The simplest resolution is to manually specify cluster and service CIDRs for the clusters.

    Sample Use Cases

    In all cases, you begin by leaving the application running for at least 12 hours, to allow the agent to collect information.

    Case 1: Only Allow Specified Ingress/Egress Communications

    As a developer, you want to create a Kubernetes network policy that only allows your service/deployment to establish ingress and egress network communications that you explicitly allow.

    • Select the cluster namespace and deployment for your application.

      You should see pre-computed ingress and egress tables. You know the application does not communicate with any external IP for ingress or egress, so should not see any unresolved IPs. The topology map shows the same information.

    • Change a rule: You decide one service your application is communicating with is obsolete. You uncheck that row in the egress table.

    • Check the topology map. You will see the communication still exists, but is now drawn in red, meaning that it is forbidden using the current Kubernetes network policy (KNP).

    • Check the generated policy code. Verify that it follows your plan:

      • No ingress/egress raw IP

      • No entry for the service you explicitly excluded

    • Download the generated policy and upload it to your Kubernetes environment.

    • Verify that your application can only communicate with the services that were marked in black in the topology and checked in the tables. Then generate and download the policy to apply it.

    Case 2: Allow Access to Proxy Static IPs

    As a developer, you know your application uses proxies with a static IP and you want to configure a policy that allows your application to access them.

    • See the proxy IPs in the egress section of the interface

    • Use the Allow Egress to IP mask to create a manual rule to allow those IPs in particular

    • De-select all the other entries in the ingress and egress tables

    • Looking at the topology map, verify that only the communications to these external IPs are marked in black, the other communications with the other services/deployments are marked in red

    • Download the generated Kubernetes network policy and apply it.

    Case 3: Allow Communication Only Inside the Namespace

    You know that your application should only communicate inside the namespace, both for ingress and for egress.

    • Allow ingress inside the namespace using the general rules

    • Allow egress inside the namespace using the general rules

    • Generate the policy and confirm: everything inside the namespace is allowed, without nominating a particular service/deployment, then apply it.

    Case 4: Allow Access to a Specified Namespace, Egress Only

    Your application deployment A only communicates with applications in deployment B, which lives in a different namespace. You only need that egress traffic; there is no ingress traffic required for that communication.

    • Verify that the ingress table is empty, both for Kubernetes entities and for raw IPs

    • Verify that the only communication listed on the Egress table is communication with deployment B

    • Download the autogenerated policy, apply it, and verify:

      • Your application cannot communicate with other entities inside A’s namespace

      • The application can contact the cluster DNS server to resolve other entities

    Case 5: Allow Access When a Deployment Has Been Relabeled

    As a developer, you want to create a policy that only allows your service/deployment to establish ingress and egress network communications that you explicitly allow, and you need to make a change.

    • After leaving the application running for a few hours, you realize you didn’t tag all the namespaces involved in this policy

      A message at the top of the view will state “you need to assign labels to this namespace”.

    • Confirm the situation in the different views:

      • The generated policy should not have an entry for that communication

      • The Topology map should show the connection with a red line

    • Attach a label to the namespace that was missing it. After some minutes, a row shows the updated information.

    • Whitelist the connection appropriately.

    • Generate and download the policy and apply it.

    Troubleshooting

    Tips to resolve common error messages:

    Error message: Namespaces without labels

    Problem: Namespaces must be labeled for the KNPs to define ingress/egress rules. If non-labeled namespaces are detected in the targeted communications, the “Namespaces without labels” error message is displayed in the UI:

    Resolution: Simply assign a label to the relevant namespace and wait a few minutes for the system’s auto-detection to catch up.

    Error Message: Cluster subnet is incomplete

    Problem: To categorize unresolved IPs as inside or outside the cluster, the agent must know which CIDR ranges belong to the cluster. By default, the agent tries to discover the ranges by examining the command line arguments of the kube-apiserver and kube-controller-manager processes.

    If it cannot auto-discover the cluster subnets, the “cluster subnet is incomplete” error message is displayed in the UI:

    Resolution:

    • Preferred: Use the Configuration panel to add the CIDR entries.

    • In rare cases, you may need to configure the agent to look for the CIDR ranges in other processes than the default kube-apiserver, kube-controller-manager processes. In that case, append the following to the agent configmap:

      network_topology:
        pod_prefix_for_cidr_retrieval:
      [<PROCESS_NAME>, <PROCESS_NAME>]