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
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ kubectl --context kind-hub-quickstart-extra -n hub create secret generic hub-con

helm install hub-connector oci://xpkg.upbound.io/upbound/hub-connector \
--kube-context kind-hub-quickstart-extra \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--namespace hub \
--set connector.hub.url=http://hub-quickstart-control-plane:30080 \
--set connector.hub.tokenExchangeUrl=http://hub-quickstart-control-plane:30444 \
Expand Down
2 changes: 1 addition & 1 deletion docs/getstarted/quickstart/install-the-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ infrastructure a production install expects you to bring yourself.
```shell
helm upgrade --install hub oci://xpkg.upbound.io/upbound/hub \
--namespace hub --create-namespace \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--set global.demo.enabled=true \
--wait
```
Expand Down
10 changes: 5 additions & 5 deletions hub-docs/hub-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ that node port to a host port so you can open the Console in a browser.
```shell
helm upgrade --install hub oci://xpkg.upbound.io/upbound/hub \
--namespace hub --create-namespace \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--set global.demo.enabled=true \
--set hub-core.api.service.api.type=NodePort \
--set hub-core.api.tokenExchange.service.type=NodePort
Expand All @@ -113,7 +113,7 @@ that node port to a host port so you can open the Console in a browser.
```

:::note
Chart version 1.0.0-rc.2 rejects an explicit
Chart version 1.0.0 rejects an explicit
`hub-core.api.service.api.nodePort`, so you can't pin these ports at install
time. Kubernetes allocates them from the node port range instead.
:::
Expand Down Expand Up @@ -335,7 +335,7 @@ token for a hub credential, and streams resource state to `hub-core`.
helm install hub-connector oci://xpkg.upbound.io/upbound/hub-connector \
--kube-context kind-ctp-payments \
--namespace upbound-system \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--set connector.hub.url=http://hub-control-plane:$HUB_API_PORT \
--set connector.hub.tokenExchangeUrl=http://hub-control-plane:$HUB_TOKEN_PORT \
--set connector.hub.allowInsecure=true
Expand All @@ -359,7 +359,7 @@ token for a hub credential, and streams resource state to `hub-core`.
helm install hub-connector oci://xpkg.upbound.io/upbound/hub-connector \
--kube-context kind-ctp-analytics \
--namespace upbound-system \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--set connector.hub.url=http://hub-control-plane:$HUB_API_PORT \
--set connector.hub.tokenExchangeUrl=http://hub-control-plane:$HUB_TOKEN_PORT \
--set connector.hub.allowInsecure=true
Expand Down Expand Up @@ -531,7 +531,7 @@ Widen the filter and upgrade the release:

```shell
helm upgrade hub-connector oci://xpkg.upbound.io/upbound/hub-connector \
--version 1.0.0-rc.2 \
--version 1.0.0 \
--kube-context kind-ctp-payments \
--namespace upbound-system \
--reuse-values \
Expand Down
18 changes: 0 additions & 18 deletions hub-docs/products/insights/catalog/configuration.md

This file was deleted.

7 changes: 3 additions & 4 deletions hub-docs/products/insights/catalog/console.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Browsing the Catalog
sidebar_position: 4
sidebar_position: 2
description: Find, filter, and inspect packages across your fleet from the Console.
---

Once Catalog is [enabled](configuration.md), the Console has a **Catalog**
Once Catalog is [enabled](../../../reference/feature-flags.md), the Console has a **Catalog**
entry in the navigation sidebar and on the home page.
Open either one to see every Crossplane package image the hub has
indexed, along with where each one runs and the APIs it declares.
Expand Down Expand Up @@ -141,12 +141,11 @@ To add or manage connections, see [External registries](external-registry.md).
- **Data refreshes every 30 seconds.** Use the Refresh button for an immediate
update.
- **Catalog requires a feature flag.** The Console shows the Catalog page only
when the Catalog feature is [enabled](configuration.md).
when the Catalog feature is [enabled](../../../reference/feature-flags.md).

## See also

- [Catalog overview](overview.md)
- [Enable and configure Catalog](configuration.md)
- [External registries](external-registry.md)
- [Feature flags](../../../reference/feature-flags.md)
- [Feature lifecycle](../../../reference/feature-releases.md)
1 change: 0 additions & 1 deletion hub-docs/products/insights/catalog/external-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,4 @@ that a repository's credentials can't be resolved via the keychain.
## See also

- [Catalog overview](overview.md)
- [Enable and configure Catalog](configuration.md)
- [Feature flags](../../../reference/feature-flags.md)
1 change: 0 additions & 1 deletion hub-docs/products/insights/catalog/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ To start using Catalog, see:
**How-to guides**

- [Browsing the Catalog](console.md)
- [Enable and configure Catalog](configuration.md)

**Reference**

Expand Down
19 changes: 19 additions & 0 deletions hub-docs/reference/feature-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,25 @@ Gates go in the same `values.yaml` you installed with, and a `helm upgrade`
applies them. The `hub-core` startup logs report the resolved value of every
gate, so check them to confirm which gates the running binary picked up.

```yaml title="values.yaml"
hub-core:
api:
featureFlags:
gates:
Catalog: true
Registry: true
Metrics: true

# Required whenever the Metrics gate is on.
otelGateway:
enabled: true
metrics:
backend: prometheus
queryURL: http://prometheus-server.monitoring.svc
prometheus:
writeEndpoint: http://prometheus-server.monitoring.svc/api/v1/write
```

Disabling a beta feature works the same way in reverse. Set its gate to `false`
to turn off a feature that defaults to on.

Expand Down
9 changes: 6 additions & 3 deletions src/sidebars/hub.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,8 @@ module.exports = {
link: { type: "doc", id: "products/insights/catalog/overview" },
customProps: { badge: "Preview" },
items: [
"products/insights/catalog/configuration",
"products/insights/catalog/external-registry",
"products/insights/catalog/console",
"products/insights/catalog/external-registry",
],
},
{
Expand Down Expand Up @@ -92,7 +91,11 @@ module.exports = {
type: "category",
label: "Reference",
link: { type: "doc", id: "reference/index" },
items: ["reference/feature-flags", "reference/feature-releases"],
items: [
"reference/feature-flags",
"reference/feature-releases",
"reference/helm-values",
],
},
],
};
20 changes: 1 addition & 19 deletions static/manifests/hub/enable-features.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,11 @@ hub-core:
api:
featureFlags:
gates:
# Crossplane package catalog, and the credentials it pulls with.
Catalog: true
Registry: true
# Crossplane troubleshooting sessions. Needs the API key below.
AgentSessions: true
# Fleet-wide typedefinitions and crossplanepackages, which the
# Console's Definitions and Packages pages read. Already the default;
# set it to false to hide both pages.
AggregatedTypes: true
# Metrics also needs a gateway and a backend. See the metrics
# pipeline page.
Metrics: true

# Agent sessions read the key from the environment; the chart has no
# dedicated value for it.
extraEnv:
- name: AGENT_SESSIONS_ANTHROPIC_API_KEY
valueFrom:
secretKeyRef:
name: hub-agent-anthropic
key: ANTHROPIC_API_KEY

# Required whenever the Metrics gate is on.
# Required whenever the Metrics gate is on.
otelGateway:
enabled: true
metrics:
Expand Down
Loading