Skip to content

*: apiGroup to apiVersion #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fanminshi merged 1 commit into from
Feb 21, 2018
Merged

*: apiGroup to apiVersion #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions commands/operator-sdk/cmd/new.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var newCmd = &cobra.Command{

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

--api-group and --kind are required flags to generate the new operator application.
--api-version and --kind are required flags to generate the new operator application.

For example,
$ mkdir $GOPATH/src/github.com/example.com/
Expand All @@ -29,15 +29,15 @@ var newCmd = &cobra.Command{
}

var (
apiGroup string
apiVersion string
kind string
projectName string
)

func init() {
RootCmd.AddCommand(newCmd)
newCmd.Flags().StringVar(&apiGroup, "api-group", "", "Kubernetes API Group and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)")
newCmd.MarkFlagRequired("api-group")
newCmd.Flags().StringVar(&apiVersion, "api-version", "", "Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)")
newCmd.MarkFlagRequired("api-version")
newCmd.Flags().StringVar(&kind, "kind", "", "Kubernetes CustomResourceDefintion kind. (e.g AppService)")
newCmd.MarkFlagRequired("kind")
}
Expand All @@ -48,7 +48,7 @@ func newFunc(cmd *cobra.Command, args []string) {
}
parse(args)
verifyFlags()
g := generator.NewGenerator(apiGroup, kind, projectName)
g := generator.NewGenerator(apiVersion, kind, projectName)
err := g.Render()
if err != nil {
ExitWithError(ExitError, fmt.Errorf("failed to create project %v: %v", projectName, err))
Expand Down
32 changes: 17 additions & 15 deletions pkg/generator/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,17 @@ const (
)

type Generator struct {
apiGroup string
kind string
// apiVersion is the kubernetes apiVersion that has the format of $GROUP_NAME/$VERSION.
apiVersion string
kind string
// projectName is name of the new operator application
// and is also the name of the base directory.
projectName string
}

// NewGenerator creates a new scaffold Generator.
func NewGenerator(apiGroup, kind, projectName string) *Generator {
return &Generator{apiGroup: apiGroup, kind: kind, projectName: projectName}
func NewGenerator(apiVersion, kind, projectName string) *Generator {
return &Generator{apiVersion: apiVersion, kind: kind, projectName: projectName}
}

// Render generates the default project structure:
Expand All @@ -41,8 +42,8 @@ func NewGenerator(apiGroup, kind, projectName string) *Generator {
// │ ├── deploy
// │ ├── pkg
// │ │ ├── apis
// │ │ │ └── <api-dir-name> // computed from apiDirName(apiGroup).
// │ │ │ └── <api-version> // computed from apiVersion(apiGroup).
// │ │ │ └── <api-dir-name> // computed from apiDirName(apiVersion).
// │ │ │ └── <version> // computed from version(apiVersion).
// │ │ └── stub
// │ └── tmp
// │ ├── build
Expand Down Expand Up @@ -99,7 +100,7 @@ func (g *Generator) renderTmp() error {
}

func (g *Generator) renderPkg() error {
if err := os.MkdirAll(filepath.Join(g.projectName, apisDir, apiDirName(g.apiGroup), apiVersion(g.apiGroup)), defaultFileMode); err != nil {
if err := os.MkdirAll(filepath.Join(g.projectName, apisDir, apiDirName(g.apiVersion), version(g.apiVersion)), defaultFileMode); err != nil {
return err
}
if err := os.MkdirAll(filepath.Join(g.projectName, stubDir), defaultFileMode); err != nil {
Expand All @@ -109,18 +110,19 @@ func (g *Generator) renderPkg() error {
return nil
}

// apiVersion extracts api version from the given apiGroup.
func apiVersion(apiGroup string) string {
return strings.Split(apiGroup, "/")[1]
// version extracts the VERSION from the given apiVersion ($GROUP_NAME/$VERSION).
func version(apiVersion string) string {
return strings.Split(apiVersion, "/")[1]
}

// groupName extracts the group name from the givem apiGroup.
func groupName(apiGroup string) string {
return strings.Split(apiGroup, "/")[0]
// groupName extracts the GROUP_NAME from the given apiVersion ($GROUP_NAME/$VERSION).
func groupName(apiVersion string) string {
return strings.Split(apiVersion, "/")[0]
}

// apiDirName extracts the name of api directory under ../apis/ from the apiGroup.
// it uses the first word separated with "." of the groupName as the api directory name.
// apiDirName extracts the name of api directory under ../apis/ folder
// from the given apiVersion ($GROUP_NAME/$VERSION).
// the first word separated with "." of the GROUP_NAME is the api directory name.
// for example,
// apiDirName("app.example.com/v1alpha1") => "app".
func apiDirName(apiGroup string) string {
Expand Down