numaplane

module
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2024 License: Apache-2.0

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.

Directories

Path Synopsis
cmd
internal
git
sync
Package sync is used to sync the manifests defined in the GitSync object into the local cluster.
Package sync is used to sync the manifests defined in the GitSync object into the local cluster.
pkg
apis/numaplane/v1alpha1
Package v1alpha1 contains API Schema definitions for the numaplane.numaproj.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=numaplane.numaproj.io
Package v1alpha1 contains API Schema definitions for the numaplane.numaproj.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=numaplane.numaproj.io
client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/numaplane/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/clientset/versioned/typed/numaplane/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL