backstage-catalog-importer

command module
v0.37.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

CircleCI

Backstage catalog importer

A Go CLI to generate Backstage catalog YAML for Backstage instances like the Giant Swarm developer portal. It is highly opinionated and tailored to our specific needs.

A container image is available via

gsoci.azurecr.io/giantswarm/backstage-catalog-importer:[tag]

See the docs folder for information on usage and development.

The usual

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
Package cmd contains CLI commands.
Package cmd contains CLI commands.
charts
Provides the 'charts' command to export OCI registry charts as Backstage entities.
Provides the 'charts' command to export OCI registry charts as Backstage entities.
crd
Package crd provides the 'crd' command to export CRDs as Backstage API entities.
Package crd provides the 'crd' command to export CRDs as Backstage API entities.
groups
Provides the 'groups' command to export Giant Swarm GitHub teams as Backstage group entities.
Provides the 'groups' command to export Giant Swarm GitHub teams as Backstage group entities.
installations
Provides the 'installations' command to export an installations catalog.
Provides the 'installations' command to export an installations catalog.
users
Provides the 'users' command to export a users catalog.
Provides the 'users' command to export a users catalog.
pkg
httpclient
Package httpclient provides a retry-capable HTTP client for use with external APIs.
Package httpclient provides a retry-capable HTTP client for use with external APIs.
input/crdconfig
Package crdconfig provides functionality to parse CRD configuration files.
Package crdconfig provides functionality to parse CRD configuration files.
input/githuburl
Package githuburl provides functionality to fetch content from GitHub URLs.
Package githuburl provides functionality to fetch content from GitHub URLs.
input/installations
Reads Giant Swarm installations info from the giantswarm/installations repository
Reads Giant Swarm installations info from the giantswarm/installations repository
input/ociregistry
Package ociregistry provides a means to read repositories from an OCI registry.
Package ociregistry provides a means to read repositories from an OCI registry.
input/repositories
Package repositories provides types and tools to deal with Giant Swarm's repository configuration data maintained in https://github.com/giantswarm/github/tree/master/repositories
Package repositories provides types and tools to deal with Giant Swarm's repository configuration data maintained in https://github.com/giantswarm/github/tree/master/repositories
input/teams
Package teams provides means to export GitHub teams to Backstage group entities.
Package teams provides means to export GitHub teams to Backstage group entities.
output/catalog/api
Package api provides high level structs and functions to create catalog entities of type "API" in an opinionated way.
Package api provides high level structs and functions to create catalog entities of type "API" in an opinionated way.
output/catalog/component
Package component provides high level structs and functions to create catalog entities of type "component" in an opinionated way.
Package component provides high level structs and functions to create catalog entities of type "component" in an opinionated way.
output/catalog/user
Represents a user to be exported into a Backstage catalog as a User entity.
Represents a user to be exported into a Backstage catalog as a User entity.
output/export
Package export takes bscatalog entities and writes them to YAML files.
Package export takes bscatalog entities and writes them to YAML files.
util/component
Package component provides utility functions for component metadata handling.
Package component provides utility functions for component metadata handling.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL