Status Fields

Related Documentation

Status fields

Each Kubernetes resource that is mapped to a Konnect entity has several fields that indicate its status in Konnect.

Konnect native objects

Objects that are native to Konnect,they exist only in Konnect - have the following status fields:

  • id is the unique identifier of the Konnect entity as assigned by Konnect API. If it’s unset (empty string), it means the Konnect entity hasn’t been created yet.
  • serverURL is the URL of the Konnect server in which the entity exists.
  • organizationID is the ID of Konnect Org that this entity has been created in.

To inspect these fields:

kubectl get <resource> <resource-name> -o yaml | yq '.status'

Example output:

conditions:
  ...
id: 7dcf6756-b2e7-4067-a19b-111111111111
organizationID: 5ca26716-02f7-4430-9117-111111111111
serverURL: https://us.api.konghq.com

These objects are defined under the konnect.konghq.com API group.

Kong Gateway configuration objects

Resources like KongConsumer, KongService, KongRoute, and KongPlugin configure Kong Gateway and are not native to Konnect. These are defined under the configuration.konghq.com API group and may be used with other controllers, such as Kong Ingress Controller.

When managed by Kong Operator for Konnect, Konnect-specific status fields appear under .status.konnect:

  • controlPlaneID: The ID of the associated Konnect Control Plane.
  • id: The unique ID assigned by the Konnect API. If empty, the entity hasn’t been created.
  • serverURL: The URL of the Konnect server where the entity resides.
  • organizationID: The Org ID under which the entity was created.

To inspect these fields:

kubectl get <resource> <resource-name> -o yaml | yq '.status.konnect'

Example output:

controlPlaneID: 7dcf6756-b2e7-4067-a19b-111111111111
id: 7dcf6756-b2e7-4067-a19b-111111111111
organizationID: 5ca26716-02f7-4430-9117-111111111111
serverURL: https://us.api.konghq.com

Status conditions

Resources also report status.conditions, where each condition carries a reason that explains the current state.

ConfigStoreRefValid on KongVault v2.3+

The KongVault reports the outcome of the reference in the ConfigStoreRefValid condition:

kubectl get kongvault <vault_prefix> -o jsonpath-as-json="{.status.conditions[?(@.type=='ConfigStoreRefValid')]}"

Reason

Meaning

Valid The referenced KonnectConfigStore is programmed and its ID was used as the config_store_id.
NotProgrammed The KonnectConfigStore exists but hasn’t been created in Konnect yet, so its ID is unknown. This resolves on its own once the Config Store is programmed.
RefNotPermitted No KongReferenceGrant in the Config Store’s namespace allows the reference. Check that the grant’s from entry names the KongVault kind with an empty namespace.
Invalid The reference can’t be used at all, for example because the KonnectConfigStore doesn’t exist, the vault backend isn’t konnect, or spec.config also sets config_store_id. The condition message names the cause, and fixing it requires a spec change.

While the reference is unresolved, Kong Operator doesn’t push the KongVault to Konnect, so that a Vault is never created with a missing or wrong Config Store ID.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!