-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme template to go/v3 scaffold templates
Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
- Loading branch information
1 parent
92e29e8
commit 8fb7288
Showing
7 changed files
with
514 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
121 changes: 121 additions & 0 deletions
121
pkg/plugins/golang/v3/scaffolds/internal/templates/readme.go
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,121 @@ | ||
/* | ||
Copyright 2022 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 templates | ||
|
||
import "sigs.k8s.io/kubebuilder/v3/pkg/machinery" | ||
|
||
var _ machinery.Template = &Readme{} | ||
|
||
// Readme scaffolds a README.md file | ||
type Readme struct { | ||
machinery.TemplateMixin | ||
machinery.BoilerplateMixin | ||
machinery.ProjectNameMixin | ||
} | ||
|
||
// SetTemplateDefaults implements file.Template | ||
func (f *Readme) SetTemplateDefaults() error { | ||
if f.Path == "" { | ||
f.Path = "README.md" | ||
} | ||
|
||
f.TemplateBody = readmeFileTemplate | ||
|
||
return nil | ||
} | ||
|
||
//nolint:lll | ||
const readmeFileTemplate = `# {{ .ProjectName }} | ||
// TODO(user): Add simple overview of use/purpose | ||
## Description | ||
// TODO(user): An in-depth paragraph about your project and overview of use | ||
## Getting Started | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster ` + "`kubectl cluster-info`" + ` shows). | ||
### Running on the cluster | ||
1. Install Instances of Custom Resources: | ||
` + | ||
"\t```sh\n" + | ||
"\tkubectl apply -f config/samples/\n" + | ||
"\t```" + | ||
` | ||
2. Build and push your image to the location specified by ` + "`IMG`" + `: | ||
` + | ||
"\t```sh\n" + | ||
"\tmake docker-build docker-push IMG=<some-registry>/<project-name>:tag\n" + | ||
"\t```" + | ||
` | ||
3. Deploy the controller to the cluster with the image specified by ` + "`IMG`" + `: | ||
` + | ||
"\t```sh\n" + | ||
"\tmake deploy IMG=<some-registry>/project-name>:tag\n" + | ||
"\t```" + | ||
` | ||
### Uninstall CRDs | ||
To delete the CRDs from the cluster: | ||
` + | ||
"\t```sh\n" + | ||
"\tmake uninstall\n" + | ||
"\t```" + | ||
` | ||
### Undeploy controller | ||
UnDeploy the controller to the cluster: | ||
` + | ||
"\t```sh\n" + | ||
"\tmake undeploy\n" + | ||
"\t```" + | ||
` | ||
## Contributing | ||
// TODO(user): Add detailed information on how you would like others to contribute to this project | ||
### How it works | ||
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | ||
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) | ||
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster | ||
### Test It Out | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster ` + "`kubectl cluster-info`" + ` shows). | ||
1. Install the CRDs into the cluster: | ||
` + | ||
// Backticks can't be escaped within backticks so have to | ||
// do this to get the backticks for Markdown code fences | ||
"\t```sh\n" + | ||
"\tmake install\n" + | ||
"\t```" + | ||
` | ||
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): | ||
` + | ||
"\t```sh\n" + | ||
"\tmake run\n" + | ||
"\t```" + | ||
` | ||
**NOTE:** You can also run this in one step by running: ` + "`make install run`" + ` | ||
**NOTE:** Run ` + "`make --help`" + ` for more information on all potential ` + "`make`" + ` targets | ||
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
## License | ||
{{ .Boilerplate }} | ||
` |
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,77 @@ | ||
# project-v3-addon | ||
// TODO(user): Add simple overview of use/purpose | ||
|
||
## Description | ||
// TODO(user): An in-depth paragraph about your project and overview of use | ||
|
||
## Getting Started | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
### Running on the cluster | ||
1. Install Instances of Custom Resources: | ||
```sh | ||
kubectl apply -f config/samples/ | ||
``` | ||
2. Build and push your image to the location specified by `IMG`: | ||
```sh | ||
make docker-build docker-push IMG=<some-registry>/<project-name>:tag | ||
``` | ||
3. Deploy the controller to the cluster with the image specified by `IMG`: | ||
```sh | ||
make deploy IMG=<some-registry>/project-name>:tag | ||
``` | ||
### Uninstall CRDs | ||
To delete the CRDs from the cluster: | ||
```sh | ||
make uninstall | ||
``` | ||
### Undeploy controller | ||
UnDeploy the controller to the cluster: | ||
```sh | ||
make undeploy | ||
``` | ||
|
||
## Contributing | ||
// TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
||
### How it works | ||
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | ||
|
||
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) | ||
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster | ||
|
||
### Test It Out | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
1. Install the CRDs into the cluster: | ||
```sh | ||
make install | ||
``` | ||
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): | ||
```sh | ||
make run | ||
``` | ||
**NOTE:** You can also run this in one step by running: `make install run` | ||
|
||
**NOTE:** Run `make --help` for more information on all potential `make` targets | ||
|
||
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
|
||
## License | ||
|
||
Copyright 2022 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. | ||
|
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,77 @@ | ||
# project-v3-config | ||
// TODO(user): Add simple overview of use/purpose | ||
|
||
## Description | ||
// TODO(user): An in-depth paragraph about your project and overview of use | ||
|
||
## Getting Started | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
### Running on the cluster | ||
1. Install Instances of Custom Resources: | ||
```sh | ||
kubectl apply -f config/samples/ | ||
``` | ||
2. Build and push your image to the location specified by `IMG`: | ||
```sh | ||
make docker-build docker-push IMG=<some-registry>/<project-name>:tag | ||
``` | ||
3. Deploy the controller to the cluster with the image specified by `IMG`: | ||
```sh | ||
make deploy IMG=<some-registry>/project-name>:tag | ||
``` | ||
### Uninstall CRDs | ||
To delete the CRDs from the cluster: | ||
```sh | ||
make uninstall | ||
``` | ||
### Undeploy controller | ||
UnDeploy the controller to the cluster: | ||
```sh | ||
make undeploy | ||
``` | ||
|
||
## Contributing | ||
// TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
||
### How it works | ||
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | ||
|
||
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) | ||
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster | ||
|
||
### Test It Out | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
1. Install the CRDs into the cluster: | ||
```sh | ||
make install | ||
``` | ||
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): | ||
```sh | ||
make run | ||
``` | ||
**NOTE:** You can also run this in one step by running: `make install run` | ||
|
||
**NOTE:** Run `make --help` for more information on all potential `make` targets | ||
|
||
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
|
||
## License | ||
|
||
Copyright 2022 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. | ||
|
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,77 @@ | ||
# project-v3-multigroup | ||
// TODO(user): Add simple overview of use/purpose | ||
|
||
## Description | ||
// TODO(user): An in-depth paragraph about your project and overview of use | ||
|
||
## Getting Started | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
### Running on the cluster | ||
1. Install Instances of Custom Resources: | ||
```sh | ||
kubectl apply -f config/samples/ | ||
``` | ||
2. Build and push your image to the location specified by `IMG`: | ||
```sh | ||
make docker-build docker-push IMG=<some-registry>/<project-name>:tag | ||
``` | ||
3. Deploy the controller to the cluster with the image specified by `IMG`: | ||
```sh | ||
make deploy IMG=<some-registry>/project-name>:tag | ||
``` | ||
### Uninstall CRDs | ||
To delete the CRDs from the cluster: | ||
```sh | ||
make uninstall | ||
``` | ||
### Undeploy controller | ||
UnDeploy the controller to the cluster: | ||
```sh | ||
make undeploy | ||
``` | ||
|
||
## Contributing | ||
// TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
||
### How it works | ||
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | ||
|
||
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) | ||
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster | ||
|
||
### Test It Out | ||
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. | ||
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). | ||
|
||
1. Install the CRDs into the cluster: | ||
```sh | ||
make install | ||
``` | ||
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): | ||
```sh | ||
make run | ||
``` | ||
**NOTE:** You can also run this in one step by running: `make install run` | ||
|
||
**NOTE:** Run `make --help` for more information on all potential `make` targets | ||
|
||
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
|
||
## License | ||
|
||
Copyright 2022 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. | ||
|
Oops, something went wrong.