Skip to content

feat: Resource alias implementation#20

Open
qitianyu29 wants to merge 7 commits into
GoogleCloudPlatform:mainfrom
qitianyu29:resource-alias
Open

feat: Resource alias implementation#20
qitianyu29 wants to merge 7 commits into
GoogleCloudPlatform:mainfrom
qitianyu29:resource-alias

Conversation

@qitianyu29

Copy link
Copy Markdown
Contributor

Support resourceAlias config described in concept.md.

User can now define resourceAlias in catalog.yaml to introduce shorter & user-friendly name for context as well as reference entry aspects.

Resource alias is a 1-1 mapping between the alias and the resourceType: resourceName, where the resourceName is the formalized 3 namespace part name.

GCP managed aspects (aka 1P aspects) will have predefined alias, those aliases cannot be reused by user. In this PR the predefined aspects are:

bigquery-dataset:
  aspect: dataplex-types.global.bigquery-dataset
bigquery-table:
  aspect: dataplex-types.global.bigquery-table
schema:
  aspect: dataplex-types.global.schema
storage:
  aspect: dataplex-types.global.storage

Examples:

1. Predefined aspects

Catalog.yaml

scope: bq-dataset.project.dataset

snapshot:
  entries:
  - dataplex-types.global.bigquery-table

After called kcmd pull, entries will be like:

name: project.dataset/table
type: dataplex-types.global.bigquery-table
resource:
  name: projects/project/datasets/dataset/tables/table
  ...
aspects:
  bigquery-table:
    ...
  schema:
    ...
  storage:
    ...

2. Custom aspects
Catalog.yaml

scope: entryGroup.project.us.eg

resourceAlias:
  custom-data:
    aspect: project.us.custom-data
snapshot:
  entries:
    projects.global.context
  aspects:
    - custom-data

After called kcmd pull, entries will be like:

name: context-entry
type: projects.global.context
resource:
  name: entry-name
  ...
aspects:
  custom-data:
    <contents>

vgoyal5 added a commit that referenced this pull request Jun 6, 2026
…ged mdcode)

Replaces toolbox/mdcode (merged PRs #15/#20/#21) and toolbox/enrichment (Python
unified table+doc enrichment agent: kcmd init/pull, generic entry type for KB
entries, sidecar overviews). Mirrors github.com/vgoyal5/enrichment-agent@main.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant