Up v3 docs - #1238
Merged
Merged
Conversation
Signed-off-by: Rae Sharp <resharp20@gmail.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
tr0njavolta
added a commit
that referenced
this pull request
Jul 31, 2026
Merging this as is to follow up with redirects and link checks. * Removes process scripts for CRDs, remove unused packages Signed-off-by: Rae Sharp <resharp20@gmail.com> * Bootstrap hub documents * Transpose documentation into this repository * Update vale and rewrites Signed-off-by: Rae Sharp <resharp20@gmail.com> * Add howtos for connecting spaces and control planes * Fix overview reference to space cluster Co-authored-by: Nicholas Thomson <RedbackThomson@users.noreply.github.com> Signed-off-by: Branden Rolston <brolston@gmail.com> * Address review * lint * Add screenshots * Update image links Signed-off-by: Rae Sharp <resharp20@gmail.com> * [platform v3] Catalog documentation Signed-off-by: Jason Tang <jason@upbound.io> * Add "Browsing the Catalog" docs page for the Console UI New page at hub-docs/features/catalog/console.md covering the Catalog web interface: package list, searching and filtering, deployment status (with RBAC scoping caveats), package detail drawer (metadata, APIs, usage tabs), and registry connection badges. Includes screenshots for each view. Sidebar position 4, between External Registries and API Reference. Uses "Console" terminology per updated naming conventions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * new edits after feature flag refactoring Signed-off-by: Jason Tang <jason@upbound.io> * Vale pass Signed-off-by: Jason Tang <jason@upbound.io> * remove API reference material in favour of dedicated docs. Signed-off-by: Jason Tang <jason@upbound.io> * remove references to deleted reference.md Signed-off-by: Jason Tang <jason@upbound.io> * Update quickstarts Signed-off-by: Rae Sharp <resharp20@gmail.com> * Add hub features Registry, Metrics, Agent Sessions, Insights Signed-off-by: Rae Sharp <resharp20@gmail.com> * docs(hub): fix stale values paths, document groupsClaim Every hub-api.* path became hub-core.* in the chart rename. groupsClaim replaces the hand-written bootstrap.files provider Cognito needed. Adds guidance on when the sample block isn't enough, and corrects "four stages" to three. * docs(hub): document replacing the browser-login provider One provider drives browser login, enforced by a unique index. Covers the migration sequence, why it isn't a single flag swap, and notes the one-step swap as a roadmap item. * GLO-1380: Add documentation for lenses for GA * docs(hub): build on the Metrics feature docs, move setup to Deploy Adds the amp backend, correlation guidance, and the space-connector path, corrects how control_plane_id and insecure are described, and moves setup into the Deploy section. control_plane_id is an authorization label, not a query label. The identity labels table advertised it as "globally unique, so queries can't collide across realms", which reads as an invitation to filter on it. It's the label the authorizer injects into every PromQL expression. The hub-api skill uses control_plane_name throughout and never mentions the id; the docs now match. otelGateway.metrics.prometheus.insecure does not skip certificate verification. It's OpenTelemetry's tls.insecure, not insecure_skip_verify. Signed-off-by: lsviben <lovro.sviben@upbound.io> * Add 'Lenses' category and update 'Registry' type Signed-off-by: rae sharp ♯ <8883519+tr0njavolta@users.noreply.github.com> * Add feature flag page Signed-off-by: Rae Sharp <resharp20@gmail.com> * Move connect docs to Deploy category * Add Hub docs for the Definitions and Packages features Document the two fleet-wide Insights views. Definitions indexes the API types connected control planes serve, correlated by group and kind, and surfaces schema variants and deprecation mismatches across the fleet. Packages lists the Crossplane packages control planes declare, correlated by OCI repository, with the versions and control planes behind each one. Each page covers opening the view, the table columns, the filter bar, the detail drawer tabs, access-scoped counts, and the API it reads. Neither restates how to flip the AggregatedTypes gate; both defer to the enablement how-to. Resolves GLO-1379 * Correct the AggregatedTypes default and drop a gate that no longer exists hub-core registers five gates, and AggregatedTypes is the one that defaults to true, so the Definitions and Packages views work on a default install. Three places said otherwise: the gate table in the feature flag reference, the aggregated types section of the enablement how-to, and the EnableFeature component, which hardcoded 'is off by default' for every gate it rendered. The component now takes an 'on' prop and the Insights overview uses it, so the default renders from one source rather than three sentences. Drop ResourceFilterExpression from the reference table, the how-to table, and the how-to's own section. hub-core has no such gate, and an unrecognized gate name fails its startup, so a reader copying it from either page ends up with a hub that doesn't start. The rule that mattered survives on the resource filtering page: expression filtering follows the API version, not a gate. Also on the Insights overview, correct the claim that enabling Catalog replaces the packages view, point its Console table at the two new sub-pages, and align the Catalog console page's navigation wording with the drawer's actual Resource Exploration section. * docs(hub): correct the tier cascade for realm to control plane Realm grants do reach into control planes. A realm-admin reads every resource in the realm regardless of control-plane RBAC; editor and viewer read only what each control plane grants. Writes always come from control-plane RBAC. Org to realm stays a hard boundary. * docs(hub): refresh RBAC API versions, identity, and control-plane setup Bindings moved to authorization v1beta1. Adds an IdentityProvider example, documents the username claim and its sub default, replaces the JWT-inspector check with kubectl auth whoami, and makes ControlPlane spec.identityProviders a step in control-plane setup. * Remove project/up from quickstart Signed-off-by: Rae Sharp <resharp20@gmail.com> * Update features>insights Signed-off-by: Rae Sharp <resharp20@gmail.com> * directory name update Signed-off-by: Rae Sharp <resharp20@gmail.com> * Update sidebar Signed-off-by: Rae Sharp <resharp20@gmail.com> * Delete hub-docs/howtos/enable-features.md Signed-off-by: rae sharp ♯ <8883519+tr0njavolta@users.noreply.github.com> * Update links and sidebar, remove unused components Signed-off-by: Rae Sharp <resharp20@gmail.com> * docs(hub): base sizing guidance on tested resource counts Replace the estimated sizing numbers with results from testing on GKE against a Cloud SQL db-custom-8-32768 instance running PostgreSQL 18. Key the tiers on total resource count, hold per-pod memory constant across tiers, and add a PostgreSQL instance class table for AWS RDS, GCP Cloud SQL, and Azure. Drop the query RPS bands, which were never measured. Also correct connector.controlPlane.apiGroups, a values path that does not exist, to connector.sync.limitToClusterRoles. * Restructure Insights as a product under Hub * Update Hub Helm values reference (main) (#1235) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Add Hub observability how-to under Production (#1237) * Add Hub observability how-to under Production Documents the service metrics hub-core exposes on :8085, the hub-observability chart as a starting point, exporting to your own backend with a collector, and the instrumentation roadmap. Distinct from the fleet Metrics pipeline. Signed-off-by: lsviben <sviben.lovro@gmail.com> * Vale/clarity edits Signed-off-by: Rae Sharp <resharp20@gmail.com> --------- Signed-off-by: lsviben <sviben.lovro@gmail.com> Signed-off-by: Rae Sharp <resharp20@gmail.com> Co-authored-by: Rae Sharp <resharp20@gmail.com> * Up v3 docs (#1238) * Update Hub Helm values reference (main) * Revert platform section changes Signed-off-by: Rae Sharp <resharp20@gmail.com> --------- Signed-off-by: Rae Sharp <resharp20@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Add three-part Hub quickstart Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Add kubectl how-to and fix Insights navigation links (#1239) * Add howto doc on configuring kubectl for the hub * Add auto-detect tab for cred helper download * Add kubectl doc to sidebar * Fix the Insights navigation path and Catalog link format The Console groups Definitions and Packages under Insights. Both pages named Resource Exploration instead, which was the drawer section when they were written. Also drop the './' prefix from their Catalog links. The Insights restructure rewrote them when catalog moved under insights, and gitlab.InternalLinkFormat rejects that form, so both pages failed Vale. --------- Co-authored-by: Branden Rolston <branden@upbound.io> Co-authored-by: Michael Goff <thephred@gmail.com> * Update placement and version string (#1240) Signed-off-by: Rae Sharp <resharp20@gmail.com> --------- Signed-off-by: Rae Sharp <resharp20@gmail.com> Signed-off-by: Branden Rolston <brolston@gmail.com> Signed-off-by: Jason Tang <jason@upbound.io> Signed-off-by: lsviben <lovro.sviben@upbound.io> Signed-off-by: rae sharp ♯ <8883519+tr0njavolta@users.noreply.github.com> Signed-off-by: lsviben <sviben.lovro@gmail.com> Co-authored-by: Nicholas Thomson <RedbackThomson@users.noreply.github.com> Co-authored-by: Branden Rolston <branden@upbound.io> Co-authored-by: Branden Rolston <brolston@gmail.com> Co-authored-by: Jason Tang <jason@upbound.io> Co-authored-by: Michael Goff <thephred@gmail.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: tnthornton <2375126+tnthornton@users.noreply.github.com> Co-authored-by: Alex Fallenstedt <afallenstedt@protonmail.com> Co-authored-by: lsviben <sviben.lovro@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Lovro Sviben <46844730+lsviben@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of change
Checklist
make vale-file FILE=docs/path/to/file.mdlocally for files changed (or will fix Vale suggestions in review)Additional notes