Skip to content

Commit

Permalink
changes based on review
Browse files Browse the repository at this point in the history 
Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
  • Loading branch information
@everettraven
everettraven committed Apr 12, 2022
1 parent 45de7c3 commit dee7b87
Show file tree
Hide file tree
Showing 7 changed files with 273 additions and 297 deletions.
9 changes: 8 additions & 1 deletion pkg/plugins/golang/v3/scaffolds/init.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package scaffolds

import (
"fmt"
"strings"

"github.com/spf13/afero"

Expand Down Expand Up @@ -112,6 +113,12 @@ func (s *initScaffolder) Scaffold() error {
},
&templates.Dockerfile{},
&templates.DockerIgnore{},
&templates.Readme{},
&templates.Readme{
BoilerplateMixin: machinery.BoilerplateMixin{
Boilerplate: strings.Replace(
strings.Replace(string(boilerplate), "/*", "", 1),
"*/", "", 1),
},
},
)
}
111 changes: 60 additions & 51 deletions pkg/plugins/golang/v3/scaffolds/internal/templates/readme.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ var _ machinery.Template = &Readme{}
type Readme struct {
machinery.TemplateMixin
machinery.BoilerplateMixin
machinery.ProjectNameMixin
}

// SetTemplateDefaults implements file.Template
Expand All @@ -38,65 +39,49 @@ func (f *Readme) SetTemplateDefaults() error {
}

//nolint:lll
const readmeFileTemplate = `# Project Name
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
In order to use this operator you will need to have a Kubernetes cluster to run against.
If you need a local cluster for testing you can use [KinD](https://kind.sigs.k8s.io/)
### Running the operator
To run this operator locally (outside of a Kubernetes cluster):
1. Install the CustomResourceDefinitions (CRDs) into the cluster:
~~~shell
make install
~~~
2. Run the controller (this will run in the foreground):
~~~shell
make run
~~~
**NOTE:** You can also run this in one step by running: <code>make install run</code>
To stop running the operator locally, you can terminate the process by pressing <code>ctrl+c</code> in the terminal window the process is running in
To run this operator on the cluster:
1. Install the CRDs:
~~~shell
kubectl apply -f config/samples/
~~~
2. Build and push your image to the location specified by <code>IMG</code>:
~~~shell
make docker-build docker-push IMG=<some-registry>/<project-name>:tag
~~~
3. Deploy the controller to the cluster with the image specified by <code>IMG</code>:
~~~shell
make deploy IMG=<some-registry>/project-name>:tag
~~~
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:
~~~shell
make uninstall
~~~
### Undeploy Controller
If you deployed the controller on the cluster, you can undeploy it with:
~~~shell
make undeploy
~~~
**NOTE:** Run <code>make --help</code> for more information on all potential <code>make</code> targets
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
` +
"\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
Expand All @@ -107,6 +92,30 @@ This project aims to follow the Kubernetes [Operator pattern](https://kubernetes
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 }}
`
90 changes: 41 additions & 49 deletions testdata/project-v3-addon/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,62 +1,36 @@
# Project Name
# 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
In order to use this operator you will need to have a Kubernetes cluster to run against.
If you need a local cluster for testing you can use [KinD](https://kind.sigs.k8s.io/)

### Running the operator
To run this operator locally (outside of a Kubernetes cluster):

1. Install the CustomResourceDefinitions (CRDs) into the cluster:
~~~shell
make install
~~~

2. Run the controller (this will run in the foreground):
~~~shell
make run
~~~

**NOTE:** You can also run this in one step by running: <code>make install run</code>

To stop running the operator locally, you can terminate the process by pressing <code>ctrl+c</code> in the terminal window the process is running in
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).

To run this operator on the cluster:

1. Install the CRDs:
~~~shell
### 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 <code>IMG</code>:
~~~shell
```
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 <code>IMG</code>:
~~~shell
```
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:
~~~shell
make uninstall
~~~

### Undeploy Controller
If you deployed the controller on the cluster, you can undeploy it with:
~~~shell
make undeploy
~~~

**NOTE:** Run <code>make --help</code> for more information on all potential <code>make</code> targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
```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
Expand All @@ -67,8 +41,26 @@ This project aims to follow the Kubernetes [Operator pattern](https://kubernetes
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");
Expand All @@ -82,4 +74,4 @@ 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.
*/

90 changes: 41 additions & 49 deletions testdata/project-v3-config/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,62 +1,36 @@
# Project Name
# 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
In order to use this operator you will need to have a Kubernetes cluster to run against.
If you need a local cluster for testing you can use [KinD](https://kind.sigs.k8s.io/)

### Running the operator
To run this operator locally (outside of a Kubernetes cluster):

1. Install the CustomResourceDefinitions (CRDs) into the cluster:
~~~shell
make install
~~~

2. Run the controller (this will run in the foreground):
~~~shell
make run
~~~

**NOTE:** You can also run this in one step by running: <code>make install run</code>

To stop running the operator locally, you can terminate the process by pressing <code>ctrl+c</code> in the terminal window the process is running in
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).

To run this operator on the cluster:

1. Install the CRDs:
~~~shell
### 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 <code>IMG</code>:
~~~shell
```
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 <code>IMG</code>:
~~~shell
```
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:
~~~shell
make uninstall
~~~

### Undeploy Controller
If you deployed the controller on the cluster, you can undeploy it with:
~~~shell
make undeploy
~~~

**NOTE:** Run <code>make --help</code> for more information on all potential <code>make</code> targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
```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
Expand All @@ -67,8 +41,26 @@ This project aims to follow the Kubernetes [Operator pattern](https://kubernetes
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");
Expand All @@ -82,4 +74,4 @@ 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.
*/

0 comments on commit dee7b87

Please sign in to comment.