Discover Packages
github.com/mattermost/mattermost-plugin-cloud
module
Version:
v0.1.37
Opens a new window with list of versions in this module.
Published: Dec 9, 2024
License: Apache-2.0
Opens a new window with license information.
README
README
¶
Mattermost Cloud Plugin
This plugin allows for the creation and management of Mattermost kubernetes installations directly from Mattermost. Commands are exposed that can be used to communicate with a remote cloud server .
Getting Started
Install the plugin.
Enter configuration information for your environment and enable the plugin.
From any channel or DM, run /cloud -h for information on using the plugin.
Developing
Run a Mattermost server and web app locally, see https://developers.mattermost.com/contribute/server/developer-setup/ and https://developers.mattermost.com/contribute/webapp/developer-setup/
Log in to create the system admin account
Run a cloud provisioning server locally, see https://github.com/mattermost/mattermost-cloud#developing
Create a webhook from your provisioning server to your Mattermost server with:
cloud webhook create --owner cloud-plugin --url http://localhost:8065/plugins/com.mattermost.cloud/webhook
Set the following env variables:
export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_USERNAME=<your-sysadmin-username>
export MM_ADMIN_PASSWORD=<your-sysadmin-password>
From the plugin directory, run make deploy to deploy the plugin to your local Mattermost server
Log in to the Mattermost server as the system admin, go to Plugins -> Mattermost Private Cloud and set the following settings:
Setting
Value
Provisioning Server URL
http://localhost:8075
Installation DNS
dev.cloud.mattermost.com
Mattermost E10 License
E10 license file contents
Mattermost E20 License
E20 license file contents
8. Enable the plugin
The plugin is now usable. Make changes to your plugin and run make deploy again to run those changes on your local Mattermost server.
Release
To release a new version of the cloud plugin please do the following steps:
Bump the version to the desire version in plugin.json and then run make apply
Create a PR with the changes, see example
To trigger a release, follow these steps:
For Patch Release: Run the following command:
make patch
This will release a patch change.
For Minor Release: Run the following command:
make minor
This will release a minor change.
For Major Release: Run the following command:
make major
This will release a major change.
For Patch Release Candidate (RC): Run the following command:
make patch-rc
This will release a patch release candidate.
For Minor Release Candidate (RC): Run the following command:
make minor-rc
This will release a minor release candidate.
For Major Release Candidate (RC): Run the following command:
make major-rc
This will release a major release candidate.
Expand ▾
Collapse ▴
Directories
¶
build
deploy
command
main handles deployment of the plugin to a development server using either the Client4 API or by copying the plugin bundle into a sibling mattermost-server/plugin directory.
main handles deployment of the plugin to a development server using either the Client4 API or by copying the plugin bundle into a sibling mattermost-server/plugin directory.
Click to show internal directories.
Click to hide internal directories.