This repository is used to track and coordinate the migration of Salt modules to extensions.
Follow these steps to set up your development environment and migrate Salt modules to extensions.
Create an empty working directory and navigate into it:
mkdir working-dir
cd working-dirInside the working directory, create an empty directory to hold the extension migration files:
mkdir apache
cd apacheUse the copier template for the latest framework of Salt Extensions. This is the preferred way to create a new extension, as there is a lot of shared code between extensions that is easier to keep in sync with copier.
Install copier
pip install copier copier-templates-extensionscopier copy --trust https://github.com/salt-extensions/salt-extension-copier saltext-apacheNavigate into the extension directory:
cd saltext-apacheIf you used the copier command to create the extension, it creates some boilerplate modules and tests that we want to get rid of before we pull in the actual code from Salt.
find src tests -type f ! -name __init__.py ! -name conftest.py -deleteInitialize it as a Git repository:
git init --initial-branch=main
pip install pre-commit # may not need to be done again if in a pre-existing virtual environment
pre-commit install
git add .
git commit -m "Initial commit of extension framework"*You may need to
pip installgit-filter-repoandpylint. If you are using git < 2.28, theinitial-branchoption is not present andgit initwill default to the branch being "master" instead of "main". Note that you won't be able to change it withgit branch -m master mainuntil after your first commit.
Note: In case of failures due to pinned project dependencies, clean out build and artifacts like below, and try again.
sudo rm -rf ./build/*
sudo rm -rf ./artifacts/*
git add .
git commit -m "Initial commit of extension framework"Follow these instructions to migrate Salt modules to extensions.
First, git clone this extension-migration to your local environment into a separate folder, not in your saltext-_____ (if it isn't already).
then, cd into the directory before saltext-_______ (example, the helm directory instead of saltext-helm)
To perform a dry run migration of modules that contain "apache" in their name from a branch called "filter-source" into an extension directory called "saltext-apache", use the following command:
extension-migrate.py --dry_run \
--file_filter apache \
--source_branch filter-source \
--extension_dir saltext-apacheNote that all the dry-run does is preprare the command and then echo it to the terminal. If you run the dry run, and then the actual migration, you may get a fatal error complaining something already is created. This is not actaully a fatal error and can be safely ignored.
To perform the actual migration of modules, use the following command:
extension-migrate.py --file_filter apache \
--source_branch filter-source \
--extension_dir saltext-apacheIf there are any merge conflicts, resolve them manually.
Merge the "filter-target" branch into the main branch:
git add .
git commit -m "Merging in modules from Salt"
git checkout main
git merge filter-targetChange any references of __utils__ to salt.utils:
SALTEXT_NAME=apache salt-rewrite -F fix_saltext_utils_imports .Finally, push the changes to the Salt extension's repository. Contact an Owner of the salt-extensions organization to
obtain a repository for your Extension.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent