xcsh_k8s_pod_security_policy (Resource)

Manages k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace. in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# K8SPodSecurityPolicy Resource Example
# Manages k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Basic K8SPodSecurityPolicy configuration
resource "xcsh_k8s_pod_security_policy" "example" {
  name      = "example-k8s-pod-security-policy"
  namespace = "staging"
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use empty block syntax field_name {}, never field_name = true. Boolean attributes (like add_hsts, http_redirect) use = true/false as normal.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the K8S Pod Security Policy. Must be unique within the namespace

• namespace - Required String
Namespace where the K8S Pod Security Policy will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

-> One of the following: • psp_spec - Optional Block
Pod Security Policy Specification. Form based pod security specification
See Psp Spec below for details.

• yaml - Optional String
K8S YAML for Pod Security Policy

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - Optional String
Unique identifier for the resource

---

Psp Spec

A psp_spec block supports the following:

• allow_privilege_escalation - Optional Bool
Pod can request to privilege escalation

• allowed_capabilities - Optional Block
List of capabilities that Docker container has
See Allowed Capabilities below.

• allowed_csi_drivers - Optional List
Restrict the available CSI drivers for POD, default all drivers are available

• allowed_flex_volumes - Optional List
Restrict list of Flex volumes, default all volumes are allowed

• allowed_host_paths - Optional Block
Restrict list of host paths, default all host paths are allowed
See Allowed Host Paths below.

• allowed_proc_mounts - Optional List
Allowed list of proc mounts, empty list allows default proc mounts

• allowed_unsafe_sysctls - Optional List
Allowed list of unsafe sysctls, empty list allows none. Supports prefix reg-ex

• default_allow_privilege_escalation - Optional Bool
Pod has permission for privilege escalation by default

• default_capabilities - Optional Block
List of capabilities that Docker container has
See Default Capabilities below.

• drop_capabilities - Optional Block
List of capabilities that Docker container has
See Drop Capabilities below.

• forbidden_sysctls - Optional List
Forbidden list of sysctls, empty list forbids none. Supports prefix reg-ex

• fs_group_strategy_options - Optional Block
Configuration parameter for fs group strategy options
See Fs Group Strategy Options below.

• host_ipc - Optional Bool
Host IPC determines if the policy allows the use of host IPC in the pod spec

• host_network - Optional Bool
Host Network determines if the policy allows the use of host network in the pod spec

• host_pid - Optional Bool
Host PID determines if the policy allows the use of host PID in the pod spec

• host_port_ranges - Optional String
Host port ranges determines which ports ranges are allowed to be exposed

• no_allowed_capabilities - Optional Block
Configuration parameter for no allowed capabilities

• no_default_capabilities - Optional Block
Configuration parameter for no default capabilities

• no_drop_capabilities - Optional Block
Configuration parameter for no drop capabilities

• no_fs_groups - Optional Block
Enable this option

• no_run_as_group - Optional Block
Configuration parameter for no run as group

• no_run_as_user - Optional Block
Configuration parameter for no run as user

• no_runtime_class - Optional Block
Configuration parameter for no runtime class

• no_se_linux_options - Optional Block
Configuration parameter for no se linux options

• no_supplemental_groups - Optional Block
Enable this option

• privileged - Optional Bool
Privileged determines if a pod can request to be run as privileged

• read_only_root_filesystem - Optional Bool
Containers can only run with read only root filesystem

• run_as_group - Optional Block
Configuration parameter for run as group
See Run As Group below.

• run_as_user - Optional Block
Configuration parameter for run as user
See Run As User below.

• supplemental_groups - Optional Block
ID(User,Group,FSGroup) Strategy. ID ranges and rules
See Supplemental Groups below.

• volumes - Optional List
Allow List of volume plugins. Empty no volumes are allowed

Psp Spec Allowed Capabilities

An allowed_capabilities block (within psp_spec) supports the following:

• capabilities - Optional List
List of capabilities that Docker container has

Psp Spec Allowed Host Paths

An allowed_host_paths block (within psp_spec) supports the following:

• path_prefix - Optional String
Host path prefix is the path prefix that the host volume must match. It does not support *

• read_only - Optional Bool
Volume will be allowed to mount read only

Psp Spec Default Capabilities

A default_capabilities block (within psp_spec) supports the following:

• capabilities - Optional List
List of capabilities that Docker container has

Psp Spec Drop Capabilities

A drop_capabilities block (within psp_spec) supports the following:

• capabilities - Optional List
List of capabilities that Docker container has

Psp Spec Fs Group Strategy Options

A fs_group_strategy_options block (within psp_spec) supports the following:

• id_ranges - Optional Block
ID Ranges. List of range of ID(s)
See ID Ranges below.

• rule - Optional String
Rule indicated how the FS group ID range is used

Psp Spec Fs Group Strategy Options ID Ranges

Deeply nested Ranges block collapsed for readability.

Psp Spec Run As Group

A run_as_group block (within psp_spec) supports the following:

• id_ranges - Optional Block
ID Ranges. List of range of ID(s)
See ID Ranges below.

• rule - Optional String
Rule indicated how the FS group ID range is used

Psp Spec Run As Group ID Ranges

An id_ranges block (within psp_spec.run_as_group) supports the following:

• max_id - Optional Number
Ending(maximum) ID for for ID range

• min_id - Optional Number
Starting(minimum) ID for for ID range

Psp Spec Run As User

A run_as_user block (within psp_spec) supports the following:

• id_ranges - Optional Block
ID Ranges. List of range of ID(s)
See ID Ranges below.

• rule - Optional String
Rule indicated how the FS group ID range is used

Psp Spec Run As User ID Ranges

An id_ranges block (within psp_spec.run_as_user) supports the following:

• max_id - Optional Number
Ending(maximum) ID for for ID range

• min_id - Optional Number
Starting(minimum) ID for for ID range

Psp Spec Supplemental Groups

A supplemental_groups block (within psp_spec) supports the following:

• id_ranges - Optional Block
ID Ranges. List of range of ID(s)
See ID Ranges below.

• rule - Optional String
Rule indicated how the FS group ID range is used

Psp Spec Supplemental Groups ID Ranges

An id_ranges block (within psp_spec.supplemental_groups) supports the following:

• max_id - Optional Number
Ending(maximum) ID for for ID range

• min_id - Optional Number
Starting(minimum) ID for for ID range

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

---

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
name	String	Name of the referenced object
namespace	String	Namespace containing the referenced object
tenant	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
LOWER_CASE	Convert to lowercase
UPPER_CASE	Convert to uppercase
BASE64_DECODE	Decodebase64 content
NORMALIZE_PATH	Normalize URL path
REMOVE_WHITESPACE	Remove whitespace characters
URL_DECODE	Decode URL-encoded characters
TRIM_LEFT	Trim leading whitespace
TRIM_RIGHT	Trim trailing whitespace
TRIM	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
ANY	Match any HTTP method
GET	HTTP GET request
HEAD	HTTP HEAD request
POST	HTTP POST request
PUT	HTTP PUT request
DELETE	HTTP DELETE request
CONNECT	HTTP CONNECT request
OPTIONS	HTTP OPTIONS request
TRACE	HTTP TRACE request
PATCH	HTTP PATCH request
COPY	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
TLS_FINGERPRINT_NONE	No fingerprint matching
ANY_MALICIOUS_FINGERPRINT	Match any known malicious fingerprint
ADWARE	Adware-associated fingerprints
DRIDEX	Dridex malware fingerprints
GOOTKIT	Gootkit malware fingerprints
RANSOMWARE	Ransomware-associated fingerprints
TRICKBOT	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
SPAM_SOURCES	Known spam sources
WINDOWS_EXPLOITS	Windows exploit sources
WEB_ATTACKS	Web attack sources
BOTNETS	Known botnet IPs
SCANNERS	Network scanner IPs
REPUTATION	Poor reputation IPs
PHISHING	Phishing-related IPs
PROXY	Anonymous proxy IPs
MOBILE_THREATS	Mobile threat sources
TOR_PROXY	Tor exit nodes
DENIAL_OF_SERVICE	DoS attack sources
NETWORK	Known bad network ranges

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import xcsh_k8s_pod_security_policy.example system/example