Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bazel CRD and RBAC role generation #543

Merged
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
9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,20 @@ examples-dev: ## Generate example output with developer image

.PHONY: manifests
manifests: cmd/clusterctl/examples/aws/out/credentials ## Generate manifests for clusterctl
go run vendor/sigs.k8s.io/controller-tools/cmd/controller-gen/main.go crd
kustomize build config/default/ > cmd/clusterctl/examples/aws/out/provider-components.yaml
echo "---" >> cmd/clusterctl/examples/aws/out/provider-components.yaml
kustomize build vendor/sigs.k8s.io/cluster-api/config/default/ >> cmd/clusterctl/examples/aws/out/provider-components.yaml

.PHONY: manifests-dev
manifests-dev: dep-ensure dep-install binaries-dev ## Builds development manifests
manifests-dev: dep-ensure dep-install binaries-dev crds ## Builds development manifests
MANAGER_IMAGE=$(DEV_MANAGER_IMAGE) MANAGER_IMAGE_PULL_POLICY="Always" $(MAKE) manifests

.PHONY: crds
crds:
bazel build //config
cp -R bazel-genfiles/config/crds/* config/crds/
cp -R bazel-genfiles/config/rbac/* config/rbac/

# TODO(vincepri): This should move to rebuild Bazel binaries once every
# make target uses Bazel bins to run operations.
.PHONY: binaries-dev
Expand Down
76 changes: 76 additions & 0 deletions build/controller_gen.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Copyright 2019 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.

# TODO: Move this to Kubebuilder repository

load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@io_kubernetes_build//defs:go.bzl", "go_genrule")

CONTROLLER_GEN = "//vendor/sigs.k8s.io/controller-tools/cmd/controller-gen"

def _qualified_genfile(label):
return "$$GO_GENRULE_EXECROOT/$(location %s)" % label

# controller_gen generates CRD and RBAC manifests for Kubernetes
# controllers based on controller runtime
# (https://github.com/kubernetes-sigs/controller-runtime) given
# Kubebuilder annotations in the Go source code.
# controller_gen will output manifests to config/crds and config/rbac
# within the projects genfiles.
def controller_gen(name, importpath, api, visibility, deps = []):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to bring these upstream if that's even possible. We should also add some more comments around these functions and their objective.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100% agree. Have added comments for now, then I'll PR to the controller-runtime repo after we know we're happy with it.

outs = [
"rbac/rbac_role.yaml",
"rbac/rbac_role_binding.yaml",
]

real_deps = [
"//pkg/apis:go_default_library",
"//pkg/cloud/aws/actuators/cluster:go_default_library",
"//pkg/cloud/aws/actuators/machine:go_default_library",
] + deps

for g in api:
group = g["group"]
version = g["version"].lower()
types = g["types"]
prefix = group.split(".")[0].lower()
real_deps += [ "//pkg/apis/%s:go_default_library" % prefix]
for t in types:
basename = t.lower()
out = "crds/%s_%s_%s.yaml" % (prefix, version, basename)
outs += [out]

cmd = """mkdir -p {source_package} && \\
cd {source_package} && \\
cp -f {project} {source_package} && \\
GENDIR=$$(dirname {gendir})/../.. && \\
{controller_gen} all && \\
cp -fR config $$GENDIR
""".format(
controller_gen = _qualified_genfile(CONTROLLER_GEN),
project = _qualified_genfile("//:PROJECT"),
gendir = _qualified_genfile(outs[0]),
source_package = "$$GOPATH/src/%s" % importpath
)

go_genrule(
name = name,
outs = outs,
srcs = ["//:PROJECT"],
cmd = cmd,
go_deps = real_deps,
visibility = visibility,
tools = [CONTROLLER_GEN],
tags = [ "generated" ],
)
17 changes: 12 additions & 5 deletions cmd/clusterctl/examples/aws/BUILD
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
genrule(
name = "example-out",
srcs = glob(["*.yaml.template"]) +
[
"addons.yaml",
"//cmd/manager:manager-amd64.digest",
],
srcs = glob(["*.yaml.template"]) + [
"addons.yaml",
"//cmd/manager:manager-amd64.digest",
],
outs = [
"out/addons.yaml",
"out/cluster.yaml",
Expand All @@ -27,3 +26,11 @@ genrule(
],
visibility = ["//visibility:public"],
)

# TODO(EKF/liztio/randomvariable): Extracted from config/build, needs real creds
genrule(
name = "test-credentials",
outs = ["out/credentials"],
cmd = "mkdir -p out && touch $@",
visibility = ["//visibility:public"],
)
20 changes: 0 additions & 20 deletions config/BUILD

This file was deleted.

57 changes: 57 additions & 0 deletions config/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Copyright 2019 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.

load("//build:controller_gen.bzl", "controller_gen")

controller_gen(
name = "config",
api = [
{
"group": "awsprovider.k8s.io",
"version": "v1alpha1",
"types": [
"AWSClusterProviderSpec",
"AWSClusterProviderStatus",
"AWSMachineProviderSpec",
"AWSMachineProviderStatus",
],
},
],
importpath = "sigs.k8s.io/cluster-api-provider-aws",
visibility = ["//visibility:public"],
)

genrule(
name = "aws-provider-yaml",
srcs = [
"//config/default:kustomization.yaml",
"//config/default:rbac_role_binding_patch.yaml",
"//config/manager:manager.yaml",
"//cmd/clusterctl/examples/aws:out/aws_manager_image_patch.yaml",
"//cmd/clusterctl/examples/aws:test-credentials",
"config",
"//:WORKSPACE",
],
outs = ["aws_provider.yaml"],
cmd = """CONFIG_SRCDIR={root_dir}/config && \\
cp -R $$CONFIG_SRCDIR/default $(@D)/default && \\
cp -R $$CONFIG_SRCDIR/manager $(@D)/manager && \\
{kustomize} build $(@D)/default > $@
""".format(
kustomize = "$(location @io_k8s_sigs_kustomize//:kustomize)",
root_dir = "$$(dirname $(location //:WORKSPACE))",
),
tools = ["@io_k8s_sigs_kustomize//:kustomize"],
visibility = ["//visibility:public"],
)
21 changes: 21 additions & 0 deletions config/default/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Copyright 2019 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.

exports_files(
[
"kustomization.yaml",
"rbac_role_binding_patch.yaml",
],
visibility = ["//visibility:public"],
)
15 changes: 15 additions & 0 deletions config/default/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2019 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.

namespace: aws-provider-system
namePrefix: aws-provider-

Expand All @@ -12,6 +26,7 @@ resources:

patches:
- ../../cmd/clusterctl/examples/aws/out/aws_manager_image_patch.yaml
- rbac_role_binding_patch.yaml

secretGenerator:
- name: manager-bootstrap-credentials
Expand Down
22 changes: 22 additions & 0 deletions config/default/rbac_role_binding_patch.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright 2019 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.

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: manager-rolebinding
subjects:
- kind: ServiceAccount
name: default
namespace: aws-provider-system
20 changes: 20 additions & 0 deletions config/manager/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2019 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.

exports_files(
[
"manager.yaml",
],
visibility = ["//visibility:public"],
)
38 changes: 35 additions & 3 deletions config/rbac/rbac_role.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
creationTimestamp: null
name: manager-role
rules:
- apiGroups:
- awsprovider.k8s.io
resources:
- awsclusterproviderconfigs
- awsclusterproviderstatuses
- awsmachineproviderconfigs
- awsmachineproviderstatuses
verbs:
- get
- list
Expand All @@ -23,6 +22,30 @@ rules:
resources:
- clusters
- clusters/status
verbs:
- get
- list
- watch
- create
- update
- patch
- delete
- apiGroups:
- awsprovider.k8s.io
resources:
- awsmachineproviderconfigs
- awsmachineproviderstatuses
verbs:
- get
- list
- watch
- create
- update
- patch
- delete
- apiGroups:
- cluster.k8s.io
resources:
- machines
- machines/status
- machinedeployments
Expand All @@ -37,6 +60,15 @@ rules:
- update
- patch
- delete
- apiGroups:
- cluster.k8s.io
resources:
- clusters
- clusters/status
verbs:
- get
- list
- watch
- apiGroups:
- ""
resources:
Expand All @@ -49,4 +81,4 @@ rules:
- create
- update
- patch
- delete
- delete
2 changes: 1 addition & 1 deletion config/rbac/rbac_role_binding.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ roleRef:
subjects:
- kind: ServiceAccount
name: default
namespace: aws-provider-system
namespace: system
3 changes: 3 additions & 0 deletions pkg/cloud/aws/actuators/cluster/actuator.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ import (
controllerError "sigs.k8s.io/cluster-api/pkg/controller/error"
)

//+kubebuilder:rbac:groups=awsprovider.k8s.io,resources=awsclusterproviderconfigs;awsclusterproviderstatuses,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=cluster.k8s.io,resources=clusters;clusters/status,verbs=get;list;watch;create;update;patch;delete

// Actuator is responsible for performing cluster reconciliation
type Actuator struct {
*deployer.Deployer
Expand Down
5 changes: 5 additions & 0 deletions pkg/cloud/aws/actuators/machine/actuator.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ import (
controllerError "sigs.k8s.io/cluster-api/pkg/controller/error"
)

//+kubebuilder:rbac:groups=awsprovider.k8s.io,resources=awsmachineproviderconfigs;awsmachineproviderstatuses,verbs=get;list;watch;create;update;patch;delete
Copy link
Contributor

@chuckha chuckha Feb 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these being added so that the rbac rules are a bit more restrictive?

//+kubebuilder:rbac:groups=cluster.k8s.io,resources=machines;machines/status;machinedeployments;machinedeployments/status;machinesets;machinesets/status,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=cluster.k8s.io,resources=clusters;clusters/status,verbs=get;list;watch
//+kubebuilder:rbac:groups="",resources=nodes;events,verbs=get;list;watch;create;update;patch;delete

// Actuator is responsible for performing machine reconciliation.
type Actuator struct {
*deployer.Deployer
Expand Down