User Bundle Catalogs - padogrid/padogrid GitHub Wiki

◀️ Bundle Repo Guidelines :link: Private Bundle Repos ▶️

---

To provide bundle catalogs that list your online bundles, follow the layout of the PadoGrid's catalog-bundles repo.

• Create a repo named catalog-bundles.
• List each product's bundles in their .md file, which must begin with the product name followed by -catalog.md in lower case. For example, geode-catalog.md for Geode, gemfire-catalog.md for GemFire, hazelcast-catalog.md for Hazelcast IMDG, jet-catalog.md for Jet, snappydata-catalog.md for SnappyData, computedb-catalog.md for ComputeDB, and etc.
• You can also combine the related products into one file. For example, geode-catalog.md for both Geode and GemFire, hazelcast-catalog.md for both Hazelcast IMDG and Jet, snappydata-catalog.md for both SnappyData and ComputeDB, and etc.
• The all-catalog.md file combines all of the products. This file is shown when the show_bundle -all -catalog is executed.
• The catalog file layout can be a simple list with links to bundle documents or a list of diagrams with links to bundle documents. There are no file format requirements but it must include the install_bundle command for each bundle listed.

The following shows the PadoGrid's catalog-bundles repo directory layout.

catalog-bundles/
├── BUILD.md
├── LICENSE
├── README.md
├── all-catalog.md
├── coherence-catalog.json
├── coherence-catalog.md
├── coherence-catalog.yaml
├── confluent-catalog.json
├── confluent-catalog.md
├── confluent-catalog.yaml
├── geode
│   └── images
├── geode-catalog.json
├── geode-catalog.md
├── geode-catalog.yaml
├── hazelcast
│   └── images
├── hazelcast-catalog.json
├── hazelcast-catalog.md
├── hazelcast-catalog.yaml
├── jet-catalog.json
├── jet-catalog.md
├── jet-catalog.yaml
├── kafka-catalog.json
├── kafka-catalog.md
├── kafka-catalog.yaml
├── none-catalog.json
├── none-catalog.md
├── none-catalog.yaml
├── snappydata
│   └── images
├── snappydata-catalog.json
├── snappydata-catalog.md
├── snappydata-catalog.yaml
├── update_all_catalogs
└── update_catalog

You can folk this repo and use the included scripts to auto-generate the catalog files. To generate all catalogs, run update_all_catalogs. You can also generate individual product catalog by running update_catalog.

# Generate all catalogs
./update_all_catalogs

# Generate Geode catalog only
./update_catalog -product geode

If you have properly created the catalog-bundles of your own then the following show_bundle command will display your Geode catalog in the browser.

show_bundle -user user1 -catalog -product geode

---

◀️ Bundle Repo Guidelines :link: Private Bundle Repos ▶️