Skip to content

CloudBoltSoftware/cloudbolt-forge

Repository files navigation

📌 Disclaimer: This open-source repository is not part of CloudBolt's official product offerings. It represents the dedication and enthusiasm of our engineers to innovate, educate, collaborate with customers, and contribute to the community. While CloudBolt as an organization supports and encourages this initiative, we cannot guarantee the accuracy, security, or functionality of the content. Think of this space as a sandbox - a place where everyone is invited to share, experiment, find and correct bugs, and make improvements. In essence, this is our way of making valuable resources and tools available at no-cost to the wider tech community.

cb_logo

Welcome to the CloudBolt Forge, a public GitHub repository used for sharing powerful content in CloudBolt. This repository holds CloudBolt actions (AKA hooks), Blueprints, UI extensions, webhooks and other content.

If you have interesting customizations that you have developed, please share them! Even if they are rough-hewn, others may admire your work, improve on it, and re-share those improvements back with you.

Importing and Exporting Actions

  • To import an action into CB, you can use the Import button on the New Action page and provide either a zip file or directory.

  • To export an action from CB, you can use the Export button on the Action Details page.

  • Some actions may have placeholder fields that you need to fill in manually, either in the JSON file before importing or in the UI after importing.

File & Directory Naming Conventions

  • Each importable piece of content should have its own directory.
  • Use no spaces or special characters in file & directory names other than underscores.

Coding Conventions

  • Please comment your code well, with a docstring at the top of each Python module and on most methods.
  • Configure your editor to help keep your code PEP8 compliant.

Contribution Process

  • First, fork the cloudbolt-forge repository.
  • Make your changes in your forked repository.
  • Then, submit a pull request to merge your changes into the CloudBoltSoftware repository.
  • By submitting a pull request for this project, you agree to license your contribution under the Apache License to this project.

Development

The CloudBolt CMP utilizes Python as it's primary language.

For a very brief primer on Python as a programming language and common methods for development, reference the python primer

Reference Sheets

The CloudBolt appliance is served from Linux, to CLI reference for those new to Linux linux cheatsheet

The CloudBolt CMP is built on the Django framework. As such, it is helpful to understand the basics of Django, primarily the syntax in templates and how to use the ORM.

For general CloudBolt development, reference the cheatsheet

For a very brief primer on Django (which CMP is based), reference the django crashcourse

License

Contributions to this project are governed by the CONTRIBUTING file and the Apache License.

Contact Us

We'd love to hear from you if you have any questions or ideas you'd like to discuss with us.

support@cloudbolt.io

http://cloudbolt.io/