pulumi/pkg/codegen/docs/gen_kubernetes.go

166 lines
4.4 KiB
Go
Raw Permalink Normal View History

//go:generate go run bundler.go
// Copyright 2016-2020, Pulumi Corporation.
//
// 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.
// Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the
// goconst linter's warning.
//
sdk/go: Remove 'nolint' directives from package docs Go treats comments that match the following regex as directives. //[a-z0-9]+:[a-z0-9] Comments that are directives don't show in an entity's documentation. https://github.com/golang/go/commit/5a550b695117f07a4f2454039a4871250cd3ed09#diff-f56160fd9fcea272966a8a1d692ad9f49206fdd8dbcbfe384865a98cd9bc2749R165 Our code has `//nolint` directives that now show in the API Reference. This is because these directives are in one of the following forms, which don't get this special treatment. // nolint:foo //nolint: foo This change fixes all such directives found by the regex: `// nolint|//nolint: `. See bottom of commit for command used for the fix. Verification: Here's the output of `go doc` on some entities before and after this change. Before ``` % go doc github.com/pulumi/pulumi/sdk/v3/go/pulumi | head -n8 package pulumi // import "github.com/pulumi/pulumi/sdk/v3/go/pulumi" nolint: lll, interfacer nolint: lll, interfacer const EnvOrganization = "PULUMI_ORGANIZATION" ... var ErrPlugins = errors.New("pulumi: plugins requested") ``` After ``` % go doc github.com/pulumi/pulumi/sdk/v3/go/pulumi | head -n8 package pulumi // import "github.com/pulumi/pulumi/sdk/v3/go/pulumi" const EnvOrganization = "PULUMI_ORGANIZATION" ... var ErrPlugins = errors.New("pulumi: plugins requested") func BoolRef(v bool) *bool func Float64Ref(v float64) *float64 func IntRef(v int) *int func IsSecret(o Output) bool ``` Before ``` % go doc github.com/pulumi/pulumi/sdk/v3/go/pulumi URN_ package pulumi // import "github.com/pulumi/pulumi/sdk/v3/go/pulumi" func URN_(o string) ResourceOption URN_ is an optional URN of a previously-registered resource of this type to read from the engine. nolint: revive ``` After: ``` % go doc github.com/pulumi/pulumi/sdk/v3/go/pulumi URN_ package pulumi // import "github.com/pulumi/pulumi/sdk/v3/go/pulumi" func URN_(o string) ResourceOption URN_ is an optional URN of a previously-registered resource of this type to read from the engine. ``` Note that golangci-lint offers a 'nolintlint' linter that finds such miuses of nolint, but it also finds other issues so I've deferred that to a follow up PR. Resolves #11785 Related: https://github.com/golangci/golangci-lint/issues/892 [git-generate] FILES=$(mktemp) rg -l '// nolint|//nolint: ' | tee "$FILES" | xargs perl -p -i -e ' s|// nolint|//nolint|g; s|//nolint: |//nolint:|g; ' rg '.go$' < "$FILES" | xargs gofmt -w -s
2023-01-06 00:07:45 +00:00
//nolint:lll, goconst
package docs
import (
"fmt"
"path"
"strings"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
)
2022-12-12 14:55:35 +00:00
func isKubernetesPackage(pkg schema.PackageReference) bool {
return pkg.Name() == "kubernetes"
}
func (mod *modContext) isKubernetesOverlayModule() bool {
// The CustomResource overlay resource is directly under the apiextensions module
// and not under a version, so we include that. The Directory overlay resource is directly under the
// kustomize module. The resources under helm and yaml are always under a version.
return mod.mod == "apiextensions" || mod.mod == "kustomize" ||
strings.HasPrefix(mod.mod, "helm") || strings.HasPrefix(mod.mod, "yaml")
}
func (mod *modContext) isComponentResource() bool {
// TODO: Support this more generally. For now, only the Helm, Kustomize, and YAML overlays use ComponentResources.
return strings.HasPrefix(mod.mod, "helm") ||
strings.HasPrefix(mod.mod, "kustomize") ||
strings.HasPrefix(mod.mod, "yaml")
}
// getKubernetesOverlayPythonFormalParams returns the formal params to render
// for a Kubernetes overlay resource. These resources do not follow convention
// that other resources do, so it is best to manually set these.
func getKubernetesOverlayPythonFormalParams(modName string) []formalParam {
var params []formalParam
switch modName {
case "helm.sh/v2", "helm.sh/v3":
// Chart options.
params = []formalParam{
{
Name: "release_name",
Type: propertyType{Name: "str"},
Comment: "Name of the Chart (e.g., nginx-ingress).",
},
{
Name: "config",
Comment: "Configuration options for the Chart.",
},
{
Name: "opts",
DefaultValue: "=None",
Comment: "A bag of options that control this resource's behavior.",
},
}
case "kustomize":
params = []formalParam{
{
Name: "directory",
},
{
Name: "opts",
DefaultValue: "=None",
},
{
Name: "transformations",
DefaultValue: "=None",
},
{
Name: "resource_prefix",
DefaultValue: "=None",
},
}
case "yaml":
params = []formalParam{
{
Name: "file",
},
{
Name: "opts",
DefaultValue: "=None",
},
{
Name: "transformations",
DefaultValue: "=None",
},
{
Name: "resource_prefix",
DefaultValue: "=None",
},
}
case "apiextensions":
params = []formalParam{
{
Name: "api_version",
},
{
Name: "kind",
},
{
Name: "metadata",
DefaultValue: "=None",
},
{
Name: "opts",
DefaultValue: "=None",
},
}
default:
panic(fmt.Sprintf("Unknown kubernetes overlay module %q", modName))
}
return params
}
func getKubernetesMod(pkg *schema.Package, token string, modules map[string]*modContext, tool string) *modContext {
modName := pkg.TokenToModule(token)
// Kubernetes' moduleFormat in the schema will match everything
// in the token. So strip some well-known domain name parts from the module
// names.
modName = strings.TrimSuffix(modName, ".k8s.io")
modName = strings.TrimSuffix(modName, ".apiserver")
modName = strings.TrimSuffix(modName, ".authorization")
mod, ok := modules[modName]
if !ok {
mod = &modContext{
2022-12-12 14:55:35 +00:00
pkg: pkg.Reference(),
mod: modName,
tool: tool,
}
if modName != "" {
parentName := path.Dir(modName)
// If the parent name is blank, it means this is the package-level.
if parentName == "." || parentName == "" {
parentName = ":index:"
} else {
parentName = ":" + parentName + ":"
}
parent := getKubernetesMod(pkg, parentName, modules, tool)
parent.children = append(parent.children, mod)
}
modules[modName] = mod
}
return mod
}