DOCSEARCHbyAlgolia
Submit Docs

CNCF Landscape

repository·master·Indexed 27 days ago

https://github.com/cncf/landscape

Data files and images used to generate the CNCF Cloud Native Landscape. Includes guidelines for adding new projects, configuring the landscape.yml file, assigning Technical Advisory Groups (TAGs), and defining item summary fields such as personas, use cases, and release rates.

Tokens
796
Snippets
0
Records
5
Agent score
45%

What's inside cncf-landscape

  1. Add a new entry to the CNCF Landscape

    master

    To add a new project or product to the CNCF Landscape, follow these steps:

    1. Prepare the logo: Create an SVG version of your logo. It must include the company, product, or project name in English. Use stacked (not horizontal) variants and ensure it does not have a non-white/non-transparent background color.
    2. Upload the logo: Add the SVG file to the hosted_logos directory.
    3. Update the data file: Open a pull request to add the entry in alphabetical order to the landscape.yml file.
    4. Reference the logo: In landscape.yml, set the logo field to point to your new SVG file.

    Guidelines for inclusion:

    • Cloud native projects should ideally have at least 300 GitHub stars and fit into an existing category.
    • Only one box per company/product is generally allowed.
    • Commercial versions of open source software are typically excluded, except for Certified Kubernetes implementations.
    • Closed source products must link to a clear product description.
    • The Crunchbase organization field should represent the entity controlling the software.

    Once your PR is merged, changes will be visible on the live landscape within 24 hours.

  2. Configure the Item Summary in landscape.yml

    master

    To display a summary section in the CNCF Landscape item detail view, you must add specific fields to the extra section of your project's landscape.yml file.

    Note: You must be a project owner, maintainer, or have a strong project affiliation to update this information.

  3. Configure extra fields for landscape entries

    master

    You can enrich your project's entry in the landscape by using the extra section within the landscape.yml file. This allows you to provide essential details that help users understand your project's purpose.

    For a complete list of supported fields, refer to the Extra Fields Documentation in the landscape2 repository.

  4. Assign a Technical Advisory Group (TAG) to an entry

    master

    To specify which Technical Advisory Group (TAG) owns a project, add a tag field within the extra section of your entry in landscape.yml.

    Supported TAG values are:

    • app-delivery
    • contributor-strategy
    • environmental-sustainability
    • network
    • observability
    • runtime
    • security
    • storage

    If you do not provide this field, the system attempts to detect it automatically based on category mappings, but manual assignment is recommended for accuracy.

  5. Reference summary fields for landscape.yml

    master

    The following keys are available within the extra section of a landscape.yml file to populate the item detail summary:

    KeyDescription
    summary_personasTarget users (e.g., Developers, SREs, Architects).
    summary_tagsTechnical features/properties used for high-level differentiation (e.g., edge, iot, baremetal).
    summary_use_caseThe technical problem the project solves. Limit to 500 characters.
    summary_business_use_caseThe business value or problem solved (e.g., reducing risk, increasing responsiveness). Limit to 500 characters.
    summary_release_rateThe frequency of new version releases (e.g., Major release every 2 months).
    summary_integrationsA list of compatible or integrated technologies.
    summary_intro_urlAn optional URL for a product pitch video (e.g., YouTube).