Skip to main content

Components

Intro​

The “component” is a central element of the RocketSLO platform.

Components represent either real artifacts produced by teams, such as libraries, APIs, packages, and services, or abstractions like features, capabilities, and products.

Each component has a unique "short name" and a stable URL, like https://rocketslo.com/components/auth-service, for easy reference.

Component registry​

Every component in RocketSLO is owned by a specific team. The team is responsible for ensuring the component's description is accurate and up-to-date. A clear and informative component description should provide any viewer with a good understanding of:

  • What the component does;
  • Where to find additional information.

Teams can provide component descriptions in several ways:

  • Textual descriptions: Write a detailed overview of the component's functionality and purpose.
  • Tags: Use tags to categorize and organize components based on relevant criteria.
  • Links to external resources: Include links to documentation, repositories, or other relevant resources for more in-depth information.

TODO: add component page screenshot

Create component​

There are 3 main ways how to create components in RocketSLO.

  1. RocketSLO portal:

    Access components page to create a new component:

    TODO: add create new component screenshot

  2. RocketSLO Public API:

  3. Automatically import components from existing systems such as (coming soon):

    • Kubernetes (k8s)
    • Amazon Elastic Container Service (ECS)
    • Amazon Elastic Kubernetes Service (EKS)
    • Spotify Backstage
    • GitHub
    • etc..