Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Thanks for contributing!

### Code style

The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details.
The coding style suggested by the Go community is used in operator-sdk. See the [style doc][golang-style-doc] for details.

Please follow this style to make operator-sdk easy to review, maintain and develop.

Expand Down
2 changes: 1 addition & 1 deletion internal/plugins/ansible/v1/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ func newResource(cfg config.Config, opts createOptions) *resource.Resource {

r := opts.NewResource(cfg)
r.Domain = cfg.GetDomain()
// Remove the path since this is not a Golang project.
// Remove the path since this is not a Go project.
r.Path = ""
return &r
}
2 changes: 1 addition & 1 deletion internal/plugins/helm/v1/chartutil/chart.go
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ func (opts CreateOptions) NewResource(cfg config.Config) *resource.Resource {

r := ro.NewResource(cfg)
r.Domain = cfg.GetDomain()
// remove the path since is not a Golang project
// remove the path since is not a Go project
r.Path = ""
return &r
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ This is the list of CR annotations which will modify the behavior of the operato
- `ansible.operator-sdk/reconcile-period`: Specifies the maximum time before a
reconciliation is triggered. Note that at scale, this can reduce
performance, see [watches][watches] reference for more information. This value
is parsed using the standard Golang package [time][time_pkg]. Specifically
is parsed using the standard Go package [time][time_pkg]. Specifically
[ParseDuration][time_parse_duration] is used which will apply the default
suffix of `s` giving the value in seconds.

Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/building-operators/golang/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Golang
title: Go
weight: 2
description: Guide to building a Golang Based Operator using Operator SDK
description: Guide to building a Go-based Operator using Operator SDK
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Golang Based Operator Reference
title: Go-based Operator Reference
linkTitle: Reference
weight: 100
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Golang Operator Tutorial
title: Go Operator Tutorial
linkTitle: Tutorial
weight: 30
description: An in-depth walkthough of building and running a Go-based operator.
Expand Down
2 changes: 1 addition & 1 deletion website/content/en/docs/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The Operator SDK is a framework that uses the [controller-runtime][controller_ru

The SDK provides workflows to develop operators in Go, Ansible, or Helm.

The following workflow is for a new [Golang operator][golang-guide]:
The following workflow is for a new [Go operator][golang-guide]:

1. Create a new operator project using the SDK Command Line Interface(CLI)
2. Define new resource APIs by adding Custom Resource Definitions(CRD)
Expand Down
6 changes: 3 additions & 3 deletions website/content/en/docs/upgrading-sdk-version/v1.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ title: v1.2.0
weight: 998998000
---

## (Golang based operators) Update Makefile's bundle target
## (Go-based operators) Update Makefile's bundle target

In the `Makefile` file, replace `bundle: manifests` with `bundle: manifests kustomize` to call the kustomize target when the `bundle` target is used.

_See [#4090](https://github.com/operator-framework/operator-sdk/pull/4090) for more details._

## (Golang based operators) Upgrade sigs.k8s.io/controller-runtime version to v0.6.3
## (Go-based operators) Upgrade sigs.k8s.io/controller-runtime version to v0.6.3

In the `go.mod` file replace `sigs.k8s.io/controller-runtime v0.6.2` with `sigs.k8s.io/controller-runtime v0.6.3` and then run `go mod tidy`.

_See [#4062](https://github.com/operator-framework/operator-sdk/pull/4062) for more details._

## (Golang based operators with multigroup support) Fix `CRDDirectoryPath` in `controllers/<group>/suite_test.go`
## (Go-based operators with multigroup support) Fix `CRDDirectoryPath` in `controllers/<group>/suite_test.go`

If your project is multi-group, then replace `CRDDirectoryPaths: []string{filepath.Join("..", "config", "crd", "bases")},` with `CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")},` in `suite_test.go` files found in `controllers/<group>/` directories. Otherwise, the tests will fail since this EnvTest will not be looking for the CRD's in the correct location. For more info, see [kubebuilder#1665](https://github.com/kubernetes-sigs/kubebuilder/issues/1665).

Expand Down