-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add boilerplate for clusterctl (#119)
* Add boilerplate for clusterctl * remove flags from clusterctl boilerplate
- Loading branch information
1 parent
4e08c2f
commit fd68ff1
Showing
10 changed files
with
362 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
clusterctl |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Contributing Guidelines |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# clusterctl | ||
|
||
`clusterctl` is the SIG-cluster-lifecycle sponsored tool that implements the Cluster API. | ||
|
||
Read the [experience doc here](https://docs.google.com/document/d/1-sYb3EdkRga49nULH1kSwuQFf1o6GvAw_POrsNo5d8c/edit#). | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
Follow the steps listed at [CONTRIBUTING.md](https://github.com/kubernetes-sigs/cluster-api/blob/master/cluster-api/clusterctl/CONTRIBUTING.md) to: | ||
|
||
1. Build the `clusterctl` tool | ||
|
||
``` | ||
go build | ||
``` | ||
|
||
2. Create a `machines.yaml` file configured for your cluster. See the provided template for an example. | ||
|
||
### Limitations | ||
|
||
|
||
### Creating a cluster | ||
|
||
**NOT YET SUPPORTED!** | ||
|
||
### Interacting with your cluster | ||
|
||
Once you have created a cluster, you can interact with the cluster and machine | ||
resources using kubectl: | ||
|
||
``` | ||
$ kubectl get clusters | ||
$ kubectl get machines | ||
$ kubectl get machines -o yaml | ||
``` | ||
|
||
#### Scaling your cluster | ||
|
||
**NOT YET SUPPORTED!** | ||
|
||
#### Upgrading your cluster | ||
|
||
**NOT YET SUPPORTED!** | ||
|
||
#### Node repair | ||
|
||
**NOT YET SUPPORTED!** | ||
|
||
### Deleting a cluster | ||
|
||
**NOT YET SUPPORTED!** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package cmd | ||
|
||
import ( | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
var createCmd = &cobra.Command{ | ||
Use: "create", | ||
Short: "Create a cluster API resource", | ||
Long: `Create a cluster API resource with one command`, | ||
} | ||
|
||
func init() { | ||
createCmd.AddCommand(NewCmdCreateCluster()) | ||
RootCmd.AddCommand(createCmd) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package cmd | ||
|
||
import ( | ||
"github.com/golang/glog" | ||
"github.com/spf13/cobra" | ||
"sigs.k8s.io/cluster-api/errors" | ||
) | ||
|
||
type CreateOptions struct { | ||
Cluster string | ||
Machine string | ||
ProviderComponents string | ||
} | ||
|
||
var co = &CreateOptions{} | ||
|
||
func NewCmdCreateCluster() *cobra.Command { | ||
cmd := &cobra.Command{ | ||
Use: "cluster", | ||
Short: "Create kubernetes cluster", | ||
Long: `Create a kubernetes cluster with one command`, | ||
Run: func(cmd *cobra.Command, args []string) { | ||
if co.Cluster == "" { | ||
exitWithHelp(cmd, "Please provide yaml file for cluster definition.") | ||
} | ||
if co.Machine == "" { | ||
exitWithHelp(cmd, "Please provide yaml file for machine definition.") | ||
} | ||
if co.ProviderComponents == "" { | ||
exitWithHelp(cmd, "Please provide a yaml file for provider component definitions.") | ||
} | ||
if err := RunCreate(co); err != nil { | ||
glog.Exit(err) | ||
} | ||
}, | ||
} | ||
|
||
return cmd | ||
} | ||
|
||
func RunCreate(co *CreateOptions) error { | ||
return errors.NotImplementedError | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package cmd | ||
|
||
import ( | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
var deleteCmd = &cobra.Command{ | ||
Use: "delete", | ||
Short: "Delete a cluster API resource", | ||
Long: `Delete a cluster API resource with one command`, | ||
} | ||
|
||
func init() { | ||
deleteCmd.AddCommand(NewCmdDeleteCluster()) | ||
RootCmd.AddCommand(deleteCmd) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package cmd | ||
|
||
import ( | ||
"github.com/golang/glog" | ||
"github.com/spf13/cobra" | ||
"sigs.k8s.io/cluster-api/errors" | ||
) | ||
|
||
type DeleteOptions struct { | ||
ClusterName string | ||
} | ||
|
||
var do = &DeleteOptions{} | ||
|
||
func NewCmdDeleteCluster() *cobra.Command { | ||
cmd := &cobra.Command{ | ||
Use: "delete", | ||
Short: "Delete kubernetes cluster", | ||
Long: `Delete a kubernetes cluster with one command`, | ||
Run: func(cmd *cobra.Command, args []string) { | ||
if do.ClusterName == "" { | ||
exitWithHelp(cmd, "Please provide cluster name.") | ||
} | ||
if err := RunDelete(); err != nil { | ||
glog.Exit(err) | ||
} | ||
}, | ||
} | ||
|
||
return cmd | ||
} | ||
|
||
func RunDelete() error { | ||
return errors.NotImplementedError | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package cmd | ||
|
||
import ( | ||
"flag" | ||
"io/ioutil" | ||
"os" | ||
|
||
"github.com/ghodss/yaml" | ||
"github.com/golang/glog" | ||
"github.com/spf13/cobra" | ||
"k8s.io/apiserver/pkg/util/logs" | ||
clusterv1 "sigs.k8s.io/cluster-api/pkg/apis/cluster/v1alpha1" | ||
"sigs.k8s.io/cluster-api/util" | ||
) | ||
|
||
var RootCmd = &cobra.Command{ | ||
Use: "clusterctl", | ||
Short: "cluster management", | ||
Long: `Simple kubernetes cluster management`, | ||
Run: func(cmd *cobra.Command, args []string) { | ||
// Do Stuff Here | ||
cmd.Help() | ||
}, | ||
} | ||
|
||
func Execute() { | ||
if err := RootCmd.Execute(); err != nil { | ||
glog.Exit(err) | ||
} | ||
} | ||
|
||
func parseClusterYaml(file string) (*clusterv1.Cluster, error) { | ||
bytes, err := ioutil.ReadFile(file) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
cluster := &clusterv1.Cluster{} | ||
err = yaml.Unmarshal(bytes, cluster) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return cluster, nil | ||
} | ||
|
||
func parseMachinesYaml(file string) ([]*clusterv1.Machine, error) { | ||
bytes, err := ioutil.ReadFile(file) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
machines := &clusterv1.MachineList{} | ||
err = yaml.Unmarshal(bytes, &machines) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return util.MachineP(machines.Items), nil | ||
} | ||
|
||
func exitWithHelp(cmd *cobra.Command, err string) { | ||
glog.Error(err) | ||
cmd.Help() | ||
os.Exit(1) | ||
} | ||
|
||
func init() { | ||
flag.CommandLine.Parse([]string{}) | ||
logs.InitLogs() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package main | ||
|
||
import "sigs.k8s.io/cluster-api/clusterctl/cmd" | ||
|
||
func main() { | ||
cmd.Execute() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package errors | ||
|
||
import ( | ||
"fmt" | ||
) | ||
|
||
var NotImplementedError = fmt.Errorf("not implemented") |