> ## Documentation Index
> Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Kubernetes Operator Custom Resources (CRDs)

> Reference documentation for all custom resource definitions available in the ngrok Kubernetes Operator for managing endpoints and configurations.

export const Link = ({to, className, children}) => {
  return <a href={to} className={`${className}`}>
      {children}
    </a>;
};

Kubernetes has the concept of [Custom Resource Definitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) (CRDs) which allow you to define your own custom resources.
This document will cover the CRDs you might use to achieve your goals with the ngrok Kubernetes Operator.

## ngrok Kubernetes CRDs

<div className="ngrok--cards ngrok--cards-flex ngrok--cards-row">
  <Link to={`/gateway/k8s/crds/cloudendpoint/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">CloudEndpoint</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        Centrally managed endpoints in the cloud that can be used to route traffic to Agent Endpoints.
      </p>
    </div>
  </Link>

  <Link to={`/gateway/k8s/crds/agentendpoint/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">AgentEndpoint</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        Public or internal Endpoints created by Secure Tunnel agents.
      </p>
    </div>
  </Link>
</div>

<div className="ngrok--cards ngrok--cards-flex ngrok--cards-row">
  <Link to={`/gateway/k8s/crds/ngroktrafficpolicy/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">NgrokTrafficPolicy</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        Configuration language that offers you the flexibility to filter, match, manage, and orchestrate traffic to your endpoints.
      </p>
    </div>
  </Link>

  <Link to={`/gateway/k8s/crds/boundendpoint/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">BoundEndpoint</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        Project ngrok endpoints into one or more Kubernetes clusters as Services to enable secure cluster to cluster networking without exposing them to public traffic.
      </p>
    </div>
  </Link>
</div>

<div className="ngrok--cards ngrok--cards-flex ngrok--cards-row">
  <Link to={`/gateway/k8s/crds/domain/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">Domain</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        A Domain's primary responsibility is to enable you to create public endpoints with a hostname matching the domain.
      </p>
    </div>
  </Link>

  <Link to={`/gateway/k8s/crds/kubernetesoperator/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">KubernetesOperator</h3>
      </div>

      <p className="text-md flex-grow sm:text-sm">
        Use ngrok with your Kubernetes clusters.
      </p>
    </div>
  </Link>
</div>

<div className="ngrok--cards ngrok--cards-flex ngrok--cards-row">
  <Link to={`/gateway/k8s/crds/ippolicy/`}>
    <div className="ngrok--card hover:bg-card-hover">
      <div className="ngrok--card-heading">
        <h3 className="text-md sm:text-base">IPPolicy</h3>
      </div>

      <p className="flex-grow text-md sm:text-sm">
        A policy to restrict access to an endpoint based on IP that can be used across endpoints.
      </p>
    </div>
  </Link>
</div>

## Resource status and conditions

The ngrok Kubernetes Operator uses standard Kubernetes conditions to report the state of resources. Each resource includes a `status.conditions` array that provides visibility into the current state and any issues that may need attention.

### Common condition types

The following table summarizes the condition types available across different CRD resources:

| CRD | Condition Type | Purpose |
| - | - | - |
| **Domain** | `Ready` | Overall domain readiness |
| | `DomainCreated` | Domain reservation status |
| | `CertificateReady` | TLS certificate status |
| | `DNSConfigured` | DNS configuration status |
| | `Progressing` | Domain provisioning in progress |
| **IPPolicy** | `Ready` | Overall policy readiness |
| | `IPPolicyCreated` | Policy creation status |
| | `RulesConfigured` | Rules configuration status |
| **CloudEndpoint** | `Ready` | Overall endpoint readiness |
| | `CloudEndpointCreated` | Endpoint creation status |
| | `DomainReady` | Associated domain status |
| **AgentEndpoint** | `Ready` | Overall endpoint readiness |
| | `EndpointCreated` | Endpoint creation status |
| | `TrafficPolicyApplied` | Traffic policy application status |
| | `DomainReady` | Associated domain status |
| **BoundEndpoint** | `Ready` | Overall bound endpoint readiness |
| | `ServicesCreated` | Target and upstream services creation status |
| | `ConnectivityVerified` | Upstream connectivity verification status |

### Checking resource status

You can use kubectl to check the status of your resources:

```bash theme={null}
# Check if a resource is ready
kubectl get <resource-type> <name> -o jsonpath='{.status.conditions[?(@.type=="Ready")]}'

# Wait for a resource to become ready
kubectl wait --for=condition=Ready <resource-type>/<name> --timeout=60s

# List all resources with ready status
kubectl get <resource-type> -A -o custom-columns=\
NAME:.metadata.name,\
NAMESPACE:.metadata.namespace,\
READY:.status.conditions[?(@.type==\'Ready\')].status,\
REASON:.status.conditions[?(@.type==\'Ready\')].reason
```

### Understanding condition fields

Each condition includes the following fields:

* **type**: The condition type (for example, `Ready`, `DomainCreated`)
* **status**: `True`, `False`, or `Unknown`
* **reason**: A programmatic identifier for the condition state
* **message**: A human-readable description of the condition
* **lastTransitionTime**: When the condition last changed state
* **observedGeneration**: The resource generation this condition reflects

For detailed information about the status fields and conditions for each CRD, refer to the individual CRD documentation pages linked above.