diff --git a/docs/getstarted/quickstart/connect-a-second-control-plane.md b/docs/getstarted/quickstart/connect-a-second-control-plane.md index 7c19d264..aafe1d82 100644 --- a/docs/getstarted/quickstart/connect-a-second-control-plane.md +++ b/docs/getstarted/quickstart/connect-a-second-control-plane.md @@ -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 \ diff --git a/docs/getstarted/quickstart/install-the-hub.md b/docs/getstarted/quickstart/install-the-hub.md index 1a3349d7..912f56f6 100644 --- a/docs/getstarted/quickstart/install-the-hub.md +++ b/docs/getstarted/quickstart/install-the-hub.md @@ -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 ``` diff --git a/hub-docs/hub-quickstart.md b/hub-docs/hub-quickstart.md index ae572008..432e9220 100644 --- a/hub-docs/hub-quickstart.md +++ b/hub-docs/hub-quickstart.md @@ -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 @@ -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. ::: @@ -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 @@ -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 @@ -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 \ diff --git a/hub-docs/products/insights/catalog/configuration.md b/hub-docs/products/insights/catalog/configuration.md deleted file mode 100644 index 27f50da8..00000000 --- a/hub-docs/products/insights/catalog/configuration.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Enable Catalog -sidebar_position: 2 -description: Turn on the Catalog and Registry feature gates. ---- - -To use Catalog, you must enable its feature gate. To configure image registry -connections, you must enable a separate, related feature gate. Both are alpha -features and disabled by default until you opt in. See the Catalog overview -for what Catalog does. - -For more information on configuring external registries, -see [External registries.](external-registry.md) - -| Gate | Turns on | -| --- | --- | -| `Catalog` | The catalog read API and Crossplane package indexing. | -| `Registry` | The API for connecting private or self-hosted image registries. | \ No newline at end of file diff --git a/hub-docs/products/insights/catalog/console.md b/hub-docs/products/insights/catalog/console.md index 531f42b6..2e71fbe4 100644 --- a/hub-docs/products/insights/catalog/console.md +++ b/hub-docs/products/insights/catalog/console.md @@ -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. @@ -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) diff --git a/hub-docs/products/insights/catalog/external-registry.md b/hub-docs/products/insights/catalog/external-registry.md index e32ff67c..98c989e2 100644 --- a/hub-docs/products/insights/catalog/external-registry.md +++ b/hub-docs/products/insights/catalog/external-registry.md @@ -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) diff --git a/hub-docs/products/insights/catalog/overview.md b/hub-docs/products/insights/catalog/overview.md index 6109ad1b..f0fe986a 100644 --- a/hub-docs/products/insights/catalog/overview.md +++ b/hub-docs/products/insights/catalog/overview.md @@ -60,7 +60,6 @@ To start using Catalog, see: **How-to guides** - [Browsing the Catalog](console.md) -- [Enable and configure Catalog](configuration.md) **Reference** diff --git a/hub-docs/reference/feature-flags.md b/hub-docs/reference/feature-flags.md index 1f9d1b42..c39553e3 100644 --- a/hub-docs/reference/feature-flags.md +++ b/hub-docs/reference/feature-flags.md @@ -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. diff --git a/src/sidebars/hub.js b/src/sidebars/hub.js index b4302121..6066b398 100644 --- a/src/sidebars/hub.js +++ b/src/sidebars/hub.js @@ -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", ], }, { @@ -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", + ], }, ], }; diff --git a/static/manifests/hub/enable-features.yaml b/static/manifests/hub/enable-features.yaml index 10c50220..ff57e254 100644 --- a/static/manifests/hub/enable-features.yaml +++ b/static/manifests/hub/enable-features.yaml @@ -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: