operator-sdk new

operator-sdk new

Creates a new operator application

Synopsis

The operator-sdk new command creates a new operator application and generates a default directory layout based on the input .

is the project name of the new operator. (e.g app-operator)

  1. operator-sdk new <project-name> [flags]

Examples

  1.   # Create a new project directory
  2.   $ mkdir $HOME/projects/example.com/
  3.   $ cd $HOME/projects/example.com/
  5.   # Go project
  6.   $ operator-sdk new app-operator
  8.   # Ansible project
  9.   $ operator-sdk new app-operator --type=ansible \
  10.     --api-version=app.example.com/v1alpha1 \
  11.     --kind=AppService
  13.   # Helm project
  14.   $ operator-sdk new app-operator --type=helm \
  15.   --api-version=app.example.com/v1alpha1 \
  16.   --kind=AppService
  18.   $ operator-sdk new app-operator --type=helm \
  19.   --api-version=app.example.com/v1alpha1 \
  20.   --kind=AppService \
  21.   --helm-chart=myrepo/app
  23.   $ operator-sdk new app-operator --type=helm \
  24.   --helm-chart=myrepo/app
  26.   $ operator-sdk new app-operator --type=helm \
  27.   --helm-chart=myrepo/app \
  28.   --helm-chart-version=1.2.3
  30.   $ operator-sdk new app-operator --type=helm \
  31.   --helm-chart=app \
  32.   --helm-chart-repo=https://charts.mycompany.com/
  34.   $ operator-sdk new app-operator --type=helm \
  35.   --helm-chart=app \
  36.   --helm-chart-repo=https://charts.mycompany.com/ \
  37.   --helm-chart-version=1.2.3
  39.   $ operator-sdk new app-operator --type=helm \
  40.   --helm-chart=/path/to/local/chart-directories/app/
  42.   $ operator-sdk new app-operator --type=helm \
  43.   --helm-chart=/path/to/local/chart-archives/app-1.2.3.tgz

Options

  1.       --api-version string          Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
  2.       --crd-version string          CRD version to generate (default "v1")
  3.       --generate-playbook           Generate a playbook skeleton. (Only used for --type ansible)
  4.       --git-init                    Initialize the project directory as a git repository (default false)
  5.       --header-file string          Path to file containing headers for generated Go files. Copied to hack/boilerplate.go.txt
  6.       --helm-chart string           Initialize helm operator with existing helm chart (<URL>, <repo>/<name>, or local path). Valid only for --type helm
  7.       --helm-chart-repo string      Chart repository URL for the requested helm chart, Valid only for --type helm
  8.       --helm-chart-version string   Specific version of the helm chart (default is latest version). Valid only for --type helm
  9.   -h, --help                        help for new
  10.       --kind string                 Kubernetes resource Kind name. (e.g AppService)
  11.       --repo string                 Project repository path for Go operators. Used as the project's Go import path. This must be set if outside of $GOPATH/src (e.g. github.com/example-inc/my-operator)
  12.       --skip-generation             Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs
  13.       --skip-validation             Do not validate the resulting project's structure and dependencies. (Only used for --type go)
  14.       --type string                 Type of operator to initialize (choices: "go", "ansible" or "helm") (default "go")
  15.       --vendor                      Use a vendor directory for dependencies

SEE ALSO

Last modified April 24, 2020: internal/generate/crd: change default CRD to v1 (#2874) (b17779d7)