numaplane

Numaplane is a control plane for installing, managing and running numaflow resources on Kubernetes.

Getting Started

Prerequisites

• go version v1.20.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

To build Numaplane image and run it on your local cluster with latest manifests

make start

To auto-generate code and manifests from Go

make codegen

Contributing

NOTE: Run make --help for more information on all potential make targets

How To Release

Release Branch

Always create a release branch for the releases, for example branch release-0.5 is for all the v0.5.x versions release. If it's a new release branch, simply create a branch from main.

Release Steps

1. Cherry-pick fixes to the release branch, skip this and the following two steps if it's the first release in the branch.
2. Run make test to make sure all test cases pass locally.
3. Push to remote branch, and make sure all the CI jobs pass.
4. Run make prepare-release VERSION=v{x.y.z} to update version in manifests, where x.y.x is the expected new version.
5. Follow the output of last step, to confirm if all the changes are expected, and then run make release VERSION=v{x.y.z}.
6. Follow the output, push a new tag to the release branch, GitHub actions will automatically build and publish the new release, this will take around 10 minutes.
7. Test the new release, make sure everything is running as expected, and then recreate a stable tag against the latest release.

   git tag -d stable
   git tag -a stable -m stable
   git push -d {your-remote} stable
   git push {your-remote} stable

8. Find the new release tag, and edit the release notes.

License

Copyright 2023 The Numaproj Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.