# README
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
To create a new release
git checkout release-<major>.<minor>
export VERSION=v<major>.<minor>.<patch>
make docker-buildx # this manual step will be replaced by CI
make prepare-release # follow directions for any manual steps
make release # follow directions for any manual steps
Contributing
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
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.