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.

Sign up for GitHub

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

Jump to bottom

update guide to reflect tenancy and scope #18687

Merged
merged 4 commits into from
Sep 6, 2023
Merged

update guide to reflect tenancy and scope #18687

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3773b9c
update guide to reflect tenancy and scope
dhiaayachi Sep 6, 2023
b1b411d
Apply suggestions from code review
dhiaayachi Sep 6, 2023
653cd38
update ACLHooks signature
dhiaayachi Sep 6, 2023
fb76315
Update docs/resources/guide.md
dhiaayachi Sep 6, 2023
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
27 changes: 17 additions & 10 deletions docs/resources/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,15 @@ var BarV1Alpha1Type = &pbresource.Type{

func RegisterTypes(r resource.Registry) {
r.Register(resource.Registration{
Type: BarV1Alpha1Type,
Type: BarV1Alpha1Type,
Scope: resource.ScopePartition,
Proto: &pbv1alpha1.Bar{},
})
}
```
Note that Scope reference the scope of the new resource, `resource.ScopePartition`
mean that resource will be at the partition level and have no namespace, while `resource.ScopeNamespace` mean it will have both a namespace
and a partition.

Update the `NewTypeRegistry` method in [`type_registry.go`] to call your
package's type registration method:
Expand Down Expand Up @@ -140,7 +144,8 @@ using a validation hook provided in the type registration:
func RegisterTypes(r resource.Registry) {
r.Register(resource.Registration{
Type: BarV1Alpha1Type,
Proto: &pbv1alpha1.Bar{},
Proto: &pbv1alpha1.Bar{},
Scope: resource.ScopeNamespace,
Validate: validateBar,
})
}
Expand Down Expand Up @@ -172,7 +177,8 @@ a set of ACL hooks:
func RegisterTypes(r resource.Registry) {
r.Register(resource.Registration{
Type: BarV1Alpha1Type,
Proto: &pbv1alpha1.Bar{},
Proto: &pbv1alpha1.Bar{},
Scope: resource.ScopeNamespace,
ACLs: &resource.ACLHooks{,
Read: authzReadBar,
Write: authzWriteBar,
Expand All @@ -181,19 +187,19 @@ func RegisterTypes(r resource.Registry) {
})
}

func authzReadBar(authz acl.Authorizer, id *pbresource.ID) error {
func authzReadBar(authz acl.Authorizer, authzContext *acl.AuthorizerContext, id *pbresource.ID) error {
return authz.ToAllowAuthorizer().
BarReadAllowed(id.Name, resource.AuthorizerContext(id.Tenancy))
BarReadAllowed(id.Name, authzContext)
}

func authzWriteBar(authz acl.Authorizer, id *pbresource.ID) error {
func authzWriteBar(authz acl.Authorizer, authzContext *acl.AuthorizerContext, res *pbresource.Resource) error {
return authz.ToAllowAuthorizer().
BarWriteAllowed(id.Name, resource.AuthorizerContext(id.Tenancy))
BarWriteAllowed(res.ID().Name, authzContext)
}

func authzListBar(authz acl.Authorizer, ten *pbresource.Tenancy) error {
func authzListBar(authz acl.Authorizer, authzContext *acl.AuthorizerContext) error {
return authz.ToAllowAuthorizer().
BarListAllowed(resource.AuthorizerContext(ten))
BarListAllowed(authzContext)
}
```

Expand All @@ -210,7 +216,8 @@ by providing a mutation hook:
func RegisterTypes(r resource.Registry) {
r.Register(resource.Registration{
Type: BarV1Alpha1Type,
Proto: &pbv1alpha1.Bar{},
Proto: &pbv1alpha1.Bar{},
Scope: resource.ScopeNamespace,
Mutate: mutateBar,
})
}
Expand Down