Clear Linux* OS offers many curated bundles that you can install on your system to create your desired capabilities. If the available upstream bundles do not meet your needs, you can create and add your own custom bundles to your system using one of two methods. Note: Upstream refers to the official version of Clear Linux OS.

The first method is to use the mixer tool to create your own Clear Linux OS image and add your bundles to it. Mixing your own Clear Linux OS image can give you great control and flexibility; however, you must act as an OSV and maintain your releases and updates because you have forked from upstream.

The second method is to use the mixin tool, which also makes use of mixer to create custom bundles that you can add to your upstream Clear Linux OS system. This simpler method provides a “light” forking from upstream, which means you can continue to get upstream bundles and updates. If needed, you can easily revert your system back to the upstream version.

This guide shows you how to accomplish the second method by following these steps:

  1. Set up the workspace.
  2. Copy your custom RPM package to the workspace.
  3. Create a bundle with your custom RPM package.
  4. Migrate your Clear Linux OS system to your custom mix.
  5. Add your custom bundle to your system.
  6. Optional: Revert your system back to 100% upstream.

Set up the workspace

  1. Install the mixer bundle to enable mixer.

    $ sudo swupd bundle-add mixer
    
  2. Create the workspace.

    $ sudo mkdir -p /usr/share/mix/local-rpms
    

Copy your custom RPM package to the workspace

Note

You cannot simply use RPMs from other Linux distros on Clear Linux OS. You must build RPMs specifically for Clear Linux OS in order for them to work properly. Follow the instructions on how to build RPMs found at the Developer tooling framework for Clear Linux.

If you have a local RPM you want to add to your mix you can do so by copying your RPM package to the workspace.

$ sudo cp [RPM] /usr/share/mix/local-rpms

Alternatively, you can add a remote RPM repository by running the following command.

$ sudo mixin repo add [repo-name] [repo-url]

Create a bundle with your custom RPM package

Use the mixin command to create a bundle with the RPM package.

$ sudo mixin package add [package-name] [--bundle bundle-name] [--build]

This command will add package-name to a bundle that is named after its parent repository. For example, if the RPM was provided locally, it will be added to the ‘local’ bundle. If it came from a repo that was added with mixin repo add, it will be added to a bundle named after the repo-name. If the –bundle bundle-name flag is provided, the package will be added to bundle-name instead. The –build flag tells mixin to run a mixer build after adding the package.

To add more than one RPM to your previously-created bundle, repeat the mixin package add command and change the package name. Do not add the –build flag until all packages have been added. Once done adding packages, run the following to create your local mix.

$ sudo mixin build

Note

  • The first time you run the mixin build command, mixer creates a new OS version by taking your current upstream Clear Linux OS version and multiplying it by 1000. For example, if your upstream version is 21530, your custom version will be 21530000. For each subsequent call to mixin, mixer will increment the version by 10. For example, 21530010, 21530020, etc.

Migrate your Clear Linux system to your custom mix

Before you can use your custom bundle, you must migrate your Clear Linux OS system to your custom mix to make the bundle accessible.

$ sudo swupd update --migrate

After you migrate, the version of your Clear Linux OS system switches over to your last custom version number as noted in the previous section.

You can continue to create new bundles with mixin while you are in your custom version of Clear Linux OS. You do not need to migrate again. However, you must run swupd update again to update your system in order to make those bundles visible.

Add your custom bundle to your system

  1. Get a listing of your newly-created bundle.

    $ sudo swupd bundle-list -a
    

    The listing includes all upstream bundles.

  2. Add your bundle.

    $ sudo swupd bundle-add [bundle-name]
    

Note

You can also update your system to the latest upstream version using this command:

$ sudo swupd update

Optional: Revert your system back to 100% upstream

If you want to revert your Clear Linux OS system back to the official upstream version, use this command:

$ sudo swupd verify --fix --force --picky -m [upstream-version-number] -C /usr/share/clear/update-ca/Swupd_Root.pem

After the command completes, all custom RPMs and bundles are unavailable because /usr/share/mix is deleted as part of the reversion process.