Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/guides/intelligent-control-planes/analyze-pod-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@ Upbound SaaS coming soon.
:::

<!-- vale gitlab.Uppercase = NO -->
<!-- vale Upbound.Spelling = NO -->
<!-- ignore LLM -->
[Upbound Crossplane][upbound-crossplane] is capable of running [Intelligent Control Planes][intelligent-controllers], which define AI-augmented functions to perform tasks. This guide walks through a use case for using AI to analyze and remediate issues for app deployments, such as out-of-memory and pods stuck in a _crashloopbackoff_.
[Upbound Crossplane][upbound-crossplane] is capable of running [Intelligent
Control Planes][intelligent-controllers], which define AI-augmented functions to
perform tasks. This guide walks through a use case for using AI to analyze and
remediate issues for app deployments, such as out-of-memory and pods stuck in a
_crashloopbackoff_.

<!-- vale gitlab.Uppercase = YES -->
<!-- vale Upbound.Spelling = YES -->
## Prerequisites

Before you begin make sure you have:
Expand Down Expand Up @@ -58,7 +64,9 @@ kubectl apply -f examples/admin.yaml

## Apply example deployments and watch for issues

<!-- vale Upbound.Spelling = NO -->
Apply the examples to demonstrate flows for catching and remediating out-of-memory and _crashloopbackoff_ issues:
<!-- vale Upbound.Spelling = YES -->

```shell
kubectl apply -f examples/oomkilled.yaml -f crashloopbackoff.yaml
Expand All @@ -68,7 +76,9 @@ These workloads intentionally cause the deployed pods to exhibit respective erro

## Observe analyses and remediations

The operation function pipeline creates _Analysis_ and _Remediation_ resources based on observed behaviors. Fetch an analysis object to observe suggestions for remediation made by the LLM:
The operation function pipeline creates _Analysis_ and _Remediation_ resources
based on observed behaviors. Fetch an analysis object to observe suggestions for
remediation made by the LLM:

```shell
kubectl get Analysis -n crossplane-system
Expand All @@ -89,7 +99,7 @@ Read the concept documentation for [Intelligent Control Planes][intelligent-cont

[upbound-crossplane]: /manuals/uxp/overview
[watch-operations]: /manuals/uxp/concepts/operations/watch-operation
[intelligent-controllers]: /manuals/uxp/features/intelligent-control-planes/
[intelligent-controllers]: /manuals/uxp/concepts/intelligent-control-planes/
[guide-repo]: https://github.com/upbound/configuration-deployment-analysis
[project]: /manuals/cli/concepts/projects
[intelligent-composition]: /manuals/uxp/concepts/composition/intelligent-compositions
2 changes: 1 addition & 1 deletion docs/guides/intelligent-control-planes/scale-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ up project stop
Read the concept documentation for [Intelligent Control Planes][intelligent-controlplanes] to learn more about using AI-powered functions in your function pipelines.

[upbound-crossplane]: /manuals/uxp/overview
[intelligent-controlplanes]: /manuals/uxp/features/intelligent-control-planes/
[intelligent-controlplanes]: /manuals/uxp/concepts/intelligent-control-planes/
[guide-repo]: https://github.com/upbound/configuration-aws-database-ai
[project]: /manuals/cli/concepts/projects
[intelligent-composition]: /manuals/uxp/concepts/composition/intelligent-compositions
2 changes: 1 addition & 1 deletion docs/manuals/cli/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Concepts",
"position": 4,
"position": 2,
"collapsible": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/manuals/cli/howtos/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "How-tos",
"position": 3,
"position": 2,
"collapsible": true,
"collapsed": true
}
6 changes: 3 additions & 3 deletions docs/manuals/spaces/concepts/control-planes.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Upbound gives users the ability to configure the collection of telemetry (logs,
[upbound-marketplace-1]: https://marketplace.upbound.io
[gitops-with-control-planes]: /manuals/spaces/howtos/cloud-spaces/gitops
[connect-control-planes-to-external-services]: /manuals/platform/howtos/oidc
[spaces-documentation]: /manuals/spaces/features/secrets-management
[spaces-documentation-1]: /manuals/spaces/features/backup-and-restore
[spaces-documentation]: /manuals/spaces/howtos/secrets-management
[spaces-documentation-1]: /manuals/spaces/howtos/backup-and-restore
[otel]: https://otel.com
[spaces-documentation-2]: /manuals/spaces/features/observability
[spaces-documentation-2]: /manuals/spaces/howtos/observability
2 changes: 1 addition & 1 deletion docs/manuals/spaces/concepts/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Most Kubernetes clusters come with some set of predefined namespaces. Because a
3. Labeling a Kubernetes namespace with the label `spaces.upbound.io/group=true`


[secrets]: /manuals/spaces/features/secrets-management
[secrets]: /manuals/spaces/howtos/secrets-management
[backups]: /manuals/spaces/howtos/self-hosted/workload-id/backup-restore-config/
[space]: /manuals/spaces/overview
[upbound-context]: /manuals/cli/concepts/contexts
7 changes: 0 additions & 7 deletions docs/manuals/spaces/features/_category_.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,8 @@ spec:
name: <provider-controlplane-name> # Or --name value
```

<!-- vale Google.Spacing= NO -->
<!-- vale Microsoft.Spacing= NO -->
<!-- vale Google.Spacing = NO -->
<!-- vale Microsoft.Spacing = NO -->
<!-- vale gitlab.SentenceSpacing = NO -->
The `ClusterAPIBinding` name must match the **Resource.Group** (name of the CustomResourceDefinition) of the CRD you want to bind.
<!-- vale gitlab.SentenceSpacing = YES -->
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/spaces/howtos/mcp-connector-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ In this tutorial, you:
- You saw how resource requests are actually fulfilled by the control plane.


[control-plane-connector]: /manuals/spaces/features/ctp-connector
[control-plane-connector]: /manuals/spaces/howtos/ctp-connector
[platform-reference-configuration]: https://marketplace.upbound.io/configurations/upbound/platform-ref-aws
[api-connector]: /manuals/spaces/features/api-connector
[api-connector]: /manuals/spaces/howtos/api-connector
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ Query API is required for self-hosted deployments with connected Spaces. See the
related [documentation][documentation]
to enable this feature.

[documentation]: /manuals/spaces/features/query-api/
[documentation]: /manuals/spaces/howtos/query-api/
4 changes: 2 additions & 2 deletions docs/manuals/spaces/howtos/self-hosted/capacity-licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -583,9 +583,9 @@ If your license shows as invalid:
[space-billing]: /manuals/spaces/howtos/self-hosted/billing
[CloudNativePG]: https://cloudnative-pg.io/
[backups]: https://cloudnative-pg.io/documentation/current/backup_recovery/
[backup-restore]: /manuals/spaces/features/backup-and-restore
[backup-restore]: /manuals/spaces/howtos/backup-and-restore
[sales]: https://www.upbound.io/contact
[eso]: https://external-secrets.io/
[Observability]: /manuals/spaces/features/observability
[Observability]: /manuals/spaces/howtos/observability
<!-- vale write-good.Weasel = YES -->
<!-- vale write-good.TooWordy = YES -->
2 changes: 1 addition & 1 deletion docs/manuals/spaces/howtos/self-hosted/ctp-audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,5 +539,5 @@ Delete the `SharedTelemetryConfig` to stop audit logging for all control planes
kubectl delete sharedtelemetryconfig <config-name> --namespace <namespace>
```

[ctp-selection]: /manuals/spaces/features/observability/#control-plane-selection
[ctp-selection]: /manuals/spaces/howtos/observability/#control-plane-selection
[Auditing]: https://kubernetes.io/docs/tasks/debug/debug-cluster/audit/
2 changes: 1 addition & 1 deletion docs/manuals/spaces/howtos/self-hosted/query-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ See the [Query API documentation][query-api-documentation] for more information

[postgresql-setup]: #self-hosted-postgresql-configuration
[up-cli-installed]: /manuals/cli/overview
[query-api-documentation]: /manuals/spaces/features/query-api
[query-api-documentation]: /manuals/spaces/howtos/query-api

[helm-chart-reference]: /reference/helm-reference
[kubectl-conventions]: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_get/
Expand Down
7 changes: 5 additions & 2 deletions docs/manuals/spaces/howtos/self-hosted/space-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ control plane:
| `hostcluster.id` | `x-upbound-hostcluster-id` header | Host cluster identifier |

These tags enable queries like "show all slow requests to control plane X" or
"find errors for control planes in host cluster Y".
"find errors for control planes in host cluster Y."

#### Example trace

Expand Down Expand Up @@ -242,10 +242,13 @@ upstream errors, and measure backend latency.

### Circuit breaker metrics

<!-- vale Upbound.Spelling = NO -->
<!-- ignore upstreams -->
Metrics tracking circuit breaker state and remaining capacity. Circuit breakers
prevent cascading failures by limiting connections and concurrent requests to
unhealthy upstreams. Two priority levels exist: `DEFAULT` for watch requests and
`HIGH` for API requests.
<!-- vale Upbound.Spelling = YES -->

| Name | Description |
|--------|-------------|
Expand Down Expand Up @@ -289,7 +292,7 @@ lifecycle including status codes and client-perceived latency.
| `envoy_http_downstream_rq_time_count` | Count of downstream requests |

[router-ref]: #router-ref
[observability-documentation]: /manuals/spaces/features/observability
[observability-documentation]: /manuals/spaces/howtos/observability
[opentelemetry-collector]: https://opentelemetry.io/docs/collector/
[opentelemetry-operator]: https://opentelemetry.io/docs/kubernetes/operator/
[helm-chart-reference]: /reference/helm-reference
2 changes: 1 addition & 1 deletion docs/manuals/spaces/howtos/self-hosted/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,5 @@ If you try to install a Space on an existing cluster that previously had Crosspl
<!-- vale on -->


[observability]: /manuals/spaces/features/observability
[observability]: /manuals/spaces/howtos/observability
[remove-old-crossplane-crds]: https://docs.crossplane.io/latest/guides/uninstall-crossplane/
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,6 @@ Other workload identity guides are:
* [Billing][billing]
* [Shared Secrets][secrets]

[backup-restore-guide]: /manuals/spaces/features/backup-and-restore
[backup-restore-guide]: /manuals/spaces/howtos/backup-and-restore
[billing]: /manuals/spaces/howtos/self-hosted/workload-id/billing-config
[secrets]: /manuals/spaces/howtos/self-hosted/workload-id/eso-config
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,6 @@ Other workload identity guides are:
* [Backup and restore][backuprestore]
* [Billing][billing]

[eso-guide]: /manuals/spaces/features/secrets-management
[eso-guide]: /manuals/spaces/howtos/secrets-management
[backuprestore]: /manuals/spaces/howtos/self-hosted/workload-id/backup-restore-config
[billing]: /manuals/spaces/howtos/self-hosted/workload-id/billing-config
2 changes: 1 addition & 1 deletion docs/manuals/spaces/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ For more information on Spaces offerings, review the [deployment modes][deployme
[deployment-modes]: /manuals/spaces/concepts/deployment-modes
[cloud-spaces]: /manuals/spaces/overview
[self-hosted-space]: /manuals/spaces/howtos/self-hosted/dr
[features]: /manuals/spaces/features/managed-service
[features]: /manuals/spaces/howtos/managed-service
[cloud-space-guide]: /manuals/spaces/overview
[self-hosted-space-guide]: /manuals/spaces/howtos/self-hosted/dr
2 changes: 1 addition & 1 deletion docs/manuals/uxp/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Concepts",
"position": 2,
"position": 3,
"collapsed": true
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Learn about example use cases of Intelligent Control Planes by [reading the guid
[intelligent-compositions]: /manuals/uxp/concepts/composition/intelligent-compositions
[intelligent-operations]: /manuals/uxp/concepts/operations/intelligent-operations
[mcp-servers]: #model-context-protocol-mcp-servers
[add-ons]: /manuals/uxp/features/add-ons
[add-ons]: /manuals/uxp/concepts/add-ons
[add-on-concept]: /manuals/uxp/concepts/packages/add-ons
[intelligent-control-planes-guides]: /guides/intelligent-control-planes/scale-database
[function-claude]: https://marketplace.upbound.io/functions/upbound/function-claude
Expand Down
7 changes: 0 additions & 7 deletions docs/manuals/uxp/features/_category_.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/manuals/uxp/howtos/configure-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ spec:

Your UXP instance can now pull any version of an Official Package.

[official-package-support]: /manuals/uxp/features/official-package-support
[official-package-support]: /manuals/uxp/official-package-support
[robot]: /manuals/platform/concepts/identity-management/robots
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Official Package support
description: "Learn how to use the Official Packages on UXP"
sidebar_position: 3
sidebar_position: 2
---

Upbound Crossplane supports running [Official Packages][official-packages]
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals/uxp/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Read the [Get Started][get-started] guide to learn how to use UXP to build your
[control-plane]: /getstarted/#what-is-upbound
[self-managed-uxp]: /manuals/uxp/howtos/uxp-deployment
[licensing]: /manuals/uxp/howtos/license-management
[intelligent-control-planes]: /manuals/uxp/features/intelligent-control-planes
[add-ons]: /manuals/uxp/features/add-ons
[intelligent-control-planes]: /manuals/uxp/concepts/intelligent-control-planes
[add-ons]: /manuals/uxp/concepts/add-ons
[concepts]: /manuals/uxp/concepts/composition/overview
[features]: /manuals/uxp/features/intelligent-control-planes
[features]: /manuals/uxp/concepts/intelligent-control-planes
[guides]: /manuals/uxp/howtos/uxp-deployment
[get-started]: /getstarted
2 changes: 1 addition & 1 deletion docs/reference/release-notes/spaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Any important warnings or necessary information

- **UXP v2 is now enabled by default.** Users can create UXP v2 ControlPlanes without additional configuration. This can be disabled by explicitly setting `controlPlanes.uxp.v2.enabled` to `false` if needed.
- **Query API v1alpha1 has been removed.** The query API has been updated with breaking changes including removal of v1alpha1 and Freshness support. Database user permissions required for apollo have changed; please see the [documentation](https://docs.upbound.io/manuals/spaces/howtos/self-hosted/query-api/) for details.
- UXP v2 [AddOns](https://docs.upbound.io/manuals/uxp/features/add-ons/) are disabled by default. They can be enabled via `controlPlanes.uxp.enableAddons`.
- UXP v2 [AddOns](https://docs.upbound.io/manuals/uxp/concepts/add-ons/) are disabled by default. They can be enabled via `controlPlanes.uxp.enableAddons`.
- VCluster has been upgraded from v0.24.1 to v0.24.2 to support Kubernetes 1.33.
- Bumped supported cert-manager version to v1.18.2.

Expand Down
8 changes: 8 additions & 0 deletions utils/vale/styles/Upbound/spelling-exceptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Geekdocs
Goldmark
Grammarly
Grafana
hostname
Istio
istio
image_uri
Expand All @@ -71,6 +72,8 @@ kubeconfig's
kubecontext
Kyverno
Kyverno's
LLM
LLMs
MCP
MCPs
MCP's
Expand Down Expand Up @@ -101,6 +104,7 @@ pullable
Pydantic
Pylance
readme
remediations
Rego
routable
Runtime
Expand Down Expand Up @@ -128,12 +132,15 @@ syncers
templatization
timeframe
tolerations
uninstallation
uninstall
Upbound
Upbound's
Upjet
UXP
uxp
vCluster
vcluster
virtualized
Velero
VMs
Expand All @@ -149,3 +156,4 @@ XRs
Zendesk
Upjet


Loading