Skip to content

Commit 1dbe864

Browse files
committed
Doc updates and CSV/CRD changes
1 parent aa51ef5 commit 1dbe864

File tree

5 files changed

+40
-9
lines changed

5 files changed

+40
-9
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ PKG_MAN_OPTS ?= $(FROM_VERSION) $(PKG_CHANNELS) $(PKG_IS_DEFAULT_CHANNEL)
4343
# Image URL to use all building/pushing image targets
4444
IMG ?= quay.io/redhat-cop/group-sync-operator:$(VERSION)
4545
# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
46-
CRD_OPTIONS ?= "crd:trivialVersions=true,crdVersions=v1beta1"
46+
CRD_OPTIONS ?= "crd:trivialVersions=true,crdVersions=v1beta1,preserveUnknownFields=false"
4747

4848
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
4949
ifeq (,$(shell go env GOBIN))

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,15 @@ spec:
9393

9494
#### Authenticating to Azure
9595

96-
Authentication to Azure can be performed using Service Principal with access to query group information in Azure Active Directory. A secret must be created in the same namespace that contains the `GroupSync` resource:
96+
Authentication to Azure can be performed using Application Registration with access to query group information in Azure Active Directory.
97+
98+
The App Registration must be granted access to the following Microsoft Graph API's:
99+
100+
* Group.Read.All
101+
* GroupMember.Read.All
102+
* User.Read.All
103+
104+
A secret must be created in the same namespace that contains the `GroupSync` resource:
97105

98106
The following keys must be defined in the secret
99107

@@ -362,7 +370,12 @@ spec:
362370

363371
#### Authenticating to Keycloak
364372

365-
A secret must be created in the same namespace that contains the `GroupSync` resource. It must contain the following keys:
373+
A user with rights to query for Keycloak groups must be available. The following permissions must be associated to the user:
374+
375+
* Password must be set (Temporary option unselected) on the _Credentials_ tab
376+
* On the _Role Mappings_ tab, select _master-realm_ or _realm-management_ next to the _Client Roles_ dropdown and then select **Query Groups** and **Query Users**.
377+
378+
A secret must be created in the same namespace that contains the `GroupSync` resource. It must contain the following keys for the user previously created:
366379

367380
* `username` - Username for authenticating with Keycloak
368381
* `password` - Password for authenticating with Keycloak

config/crd/bases/redhatcop.redhat.io_groupsyncs.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ spec:
1212
listKind: GroupSyncList
1313
plural: groupsyncs
1414
singular: groupsync
15+
preserveUnknownFields: false
1516
scope: Namespaced
1617
subresources:
1718
status: {}

config/manager/kustomization.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ kind: Kustomization
55
images:
66
- name: controller
77
newName: quay.io/redhat-cop/group-sync-operator
8-
newTag: v0.0.8
8+
newTag: latest

config/manifests/bases/group-sync-operator.clusterserviceversion.yaml

+22-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
categories: Security
88
certified: "false"
99
containerImage: quay.io/redhat-cop/group-sync-operator:latest
10-
createdAt: "2020-12-17T13:26:12Z"
10+
createdAt: "2020-12-23T19:02:23Z"
1111
description: Synchronize groups and users from external providers
1212
operators.operatorframework.io/builder: operator-sdk-v1.2.0
1313
operators.operatorframework.io/project_layout: go.kubebuilder.io/v2
@@ -76,6 +76,12 @@ spec:
7676
x-descriptors:
7777
- urn:alm:descriptor:com.tectonic.ui:advanced
7878
- urn:alm:descriptor:com.tectonic.ui:text
79+
- description: UserNameAttributes are the fields to consider on the User object containing the username
80+
displayName: Azure UserName Attributes
81+
path: providers[0].azure.userNameAttributes
82+
x-descriptors:
83+
- urn:alm:descriptor:com.tectonic.ui:advanced
84+
- urn:alm:descriptor:com.tectonic.ui:text
7985
- description: GitHub represents the GitHub provider
8086
displayName: GitHub Provider
8187
path: providers[0].github
@@ -481,11 +487,18 @@ spec:
481487
482488
#### Authenticating to Azure
483489
484-
Authentication to Azure can be performed using Service Principal with access to query group information in Azure Active Directory. A secret must be created in the same namespace that contains the `GroupSync` resource:
490+
Authentication to Azure can be performed using Application Registration with access to query group information in Azure Active Directory.
491+
492+
The App Registration must be granted access to the following Microsoft Graph API's:
493+
494+
* Group.Read.All
495+
* GroupMember.Read.All
496+
* User.Read.All
497+
498+
A secret must be created in the same namespace that contains the `GroupSync` resource:
485499
486500
The following keys must be defined in the secret
487501
488-
* `AZURE_SUBSCRIPTION_ID` - Subscription ID
489502
* `AZURE_TENANT_ID` - Tenant ID
490503
* `AZURE_CLIENT_ID` - Client ID
491504
* `AZURE_CLIENT_SECRET` - Client Secret
@@ -745,7 +758,12 @@ spec:
745758
746759
#### Authenticating to Keycloak
747760
748-
A secret must be created in the same namespace that contains the `GroupSync` resource. It must contain the following keys:
761+
A user with rights to query for Keycloak groups must be available. The following permissions must be associated to the user:
762+
763+
* Password must be set (Temporary option unselected) on the _Credentials_ tab
764+
* On the _Role Mappings_ tab, select _master-realm_ or _realm-management_ next to the _Client Roles_ dropdown and then select **Query Groups** and **Query Users**.
765+
766+
A secret must be created in the same namespace that contains the `GroupSync` resource. It must contain the following keys for the user previously created:
749767
750768
* `username` - Username for authenticating with Keycloak
751769
* `password` - Password for authenticating with Keycloak
@@ -842,5 +860,4 @@ spec:
842860
maturity: alpha
843861
provider:
844862
name: Red Hat Community of Practice
845-
replaces: 0.0.6
846863
version: 0.0.0

0 commit comments

Comments
 (0)