[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/rckrdstrgrd/keycloak-operator/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","rckrdstrgrd","reponame","keycloak-operator","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-11-05T09:16:16.867187Z","description","","is_private","last_updated","2020-11-05T09:23:06.849423Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",603,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![Build Status](https://travis-ci.org/keycloak/keycloak-operator.svg?branch=master)](https://travis-ci.org/keycloak/keycloak-operator)\n[![Go Report Card](https://goreportcard.com/badge/github.com/keycloak/keycloak-operator)](https://goreportcard.com/report/github.com/keycloak/keycloak-operator)\n[![Coverage Status](https://coveralls.io/repos/github/keycloak/keycloak-operator/badge.svg?branch=master)](https://coveralls.io/github/keycloak/keycloak-operator?branch=master)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n# Keycloak Operator\nA Kubernetes Operator based on the Operator SDK for creating and syncing resources in Keycloak.\n\n## Help and Documentation\n\nThe official documentation might be found in the [here](https://www.keycloak.org/docs/latest/server_installation/index.html#_operator).\n\n* [Keycloak documentation](https://www.keycloak.org/documentation.html)\n* [User Mailing List](https://lists.jboss.org/mailman/listinfo/keycloak-user) - Mailing list for help and general questions about Keycloak\n* [JIRA](https://issues.jboss.org/projects/KEYCLOAK) - Issue tracker for bugs and feature requests\n\n## Reporting Security Vulnerabilities\n\nIf you've found a security vulnerability, please look at the [instructions on how to properly report it](http://www.keycloak.org/security.html)\n\n## Reporting an issue\n\nIf you believe you have discovered a defect in the Keycloak Operator please open an issue in our [Issue Tracker](https://issues.jboss.org/projects/KEYCLOAK).\nPlease remember to provide a good summary, description as well as steps to reproduce the issue.\n\n## Supported Custom Resources\n| *CustomResourceDefinition* | *Description* |\n| --------------------------------------------------------------------- | -------------------------------------------------------- |\n| [Keycloak](./deploy/crds/keycloak.org_keycloaks_crd.yaml) | Manages, installs and configures Keycloak on the cluster |\n| [KeycloakRealm](./deploy/crds/keycloak.org_keycloakrealms_crd.yaml) | Represents a realm in a keycloak server |\n| [KeycloakClient](./deploy/crds/keycloak.org_keycloakclients_crd.yaml) | Represents a client in a keycloak server |\n| [KeycloakBackup](./deploy/crds/keycloak.org_keycloakbackups_crd.yaml) | Manage Keycloak database backups |\n\n## Deploying to a Cluster\n*Note*: You will need a running Kubernetes or OpenShift cluster to use the Operator\n\n1. Run `make cluster/prepare` # This will apply the necessary Custom Resource Definitions (CRDs) and RBAC rules to the clusters\n2. Run `kubectl apply -f deploy/operator.yaml` # This will start the operator in the current namespace\n\n### Creating Keycloak Instance\nOnce the CRDs and RBAC rules are applied and the operator is running. Use the examples from the operator.\n\n1. Run `kubectl apply -f deploy/examples/keycloak/keycloak.yaml` \n\n## Building from Source\n\n### Local Development\n*Note*: You will need a running Kubernetes or OpenShift cluster to use the Operator\n\n1. clone this repo to `$GOPATH/src/github.com/keycloak/keycloak-operator`\n2. run `make setup/mod cluster/prepare`\n3. run `make code/run`\n-- The above step will launch the operator on the local machine\n-- To see how do debug the operator or how to deploy to a cluster, see below alternatives to step 3\n4. In a new terminal run `make cluster/create/examples`\n5. Optional: configure Ingress and DNS Resolver\n - minikube: \\\n -- run `minikube addons enable ingress` \\\n -- run `./hack/modify_etc_hosts.sh`\n - Docker for Mac: \\\n -- run `kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-0.32.0/deploy/static/provider/cloud/deploy.yaml`\n (see also https://kubernetes.github.io/ingress-nginx/deploy/) \\\n -- run `./hack/modify_etc_hosts.sh keycloak.local 127.0.0.1`\n6. Run `make test/e2e`\n\nTo clean the cluster (Removes CRDs, CRs, RBAC and namespace)\n1. run `make cluster/clean`\n\n#### Alternative Step 2: Debug in Goland\nDebug the operator in [Goland](https://www.jetbrains.com/go/)\n1. go get -u github.com/go-delve/delve/cmd/dlv\n2. Create new `Go Build` debug configuration\n3. Change the properties to the following\n```\n* Name = Keycloak Operator\n* Run Kind = File\n* Files = /cmd/manager/main.go\n* Working Directory = \n* Environment = KUBERNETES_CONFIG=;WATCH_NAMESPACE=keycloak\n```\n3. Apply and click Debug Keycloak operator\n\n#### Alternative Step 3: Debug in VSCode\nDebug the operator in [VS Code](https://code.visualstudio.com/docs/languages/go)\n1. go get -u github.com/go-delve/delve/cmd/dlv\n2. Create new launch configuration, changing your kube config location\n```json\n{\n \"name\": \"Keycloak Operator\",\n \"type\": \"go\",\n \"request\": \"launch\",\n \"mode\": \"auto\",\n \"program\": \"${workspaceFolder}/cmd/manager/main.go\",\n \"env\": {\n \"WATCH_NAMESPACE\": \"keycloak\",\n \"KUBERNETES_CONFIG\": \"\"\n },\n \"cwd\": \"${workspaceFolder}\",\n \"args\": []\n}\n```\n3. Debug Keycloak Operator \n\n#### Alternative Step 3: Deploying to a Cluster\nDeploy the operator into the running cluster\n1. build image with `operator-sdk build //keycloak-operator:`. e.g. `operator-sdk build quay.io/keycloak/keycloak-operator:test`\n2. Change the `image` property in `deploy/operator.yaml` to the above full image path\n3. run `kubectl apply -f deploy/operator.yaml -n `\n\n#### Alternative Step 6: Debug the e2e tests in Goland\nDebug the e2e operator tests in [Goland](https://www.jetbrains.com/go/)\n1. Set `Test kind` to `Package`\n2. Set `Working directory` to ``\n3. Set `Go tool arguments` to `-i -parallel=1`\n4. Set `Program arguments` to `-root= -kubeconfig=/.kube/config -globalMan deploy/empty-init.yaml -namespacedMan deploy/empty-init.yaml -test.v -singleNamespace -localOperator -test.timeout 0`\n5. Apply and click Debug Keycloak operator\n\n### Makefile command reference\n#### Operator Setup Management\n| *Command* | *Description* |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------ |\n| `make cluster/prepare` | Creates the `keycloak` namespace, applies all CRDs to the cluster and sets up the RBAC files |\n| `make cluster/clean` | Deletes the `keycloak` namespace, all `keycloak.org` CRDs and all RBAC files named `keycloak-operator` |\n| `make cluster/create/examples` | Applies the example Keycloak and KeycloakRealm CRs |\n\n#### Tests\n| *Command* | *Description* |\n| ---------------------------- | ----------------------------------------------------------- |\n| `make test/unit` | Runs unit tests |\n| `make test/e2e` | Runs e2e tests with operator ran locally |\n| `make test/e2e-latest-image` | Runs e2e tests with latest available operator image running in the cluster |\n| `make test/e2e-local-image` | Runs e2e tests with local operator image running in the cluster |\n| `make test/coverage/prepare` | Prepares coverage report from unit and e2e test results |\n| `make test/coverage` | Generates coverage report |\n\n##### Running tests without cluster admin permissions\nIt's possible to deploy CRDs, roles, role bindings, etc. separately from running the tests:\n1. Run `make cluster/prepare` as a cluster admin.\n2. Run `make test/ibm-validation` as a user. The user needs the following permissions to run te tests:\n```\napiGroups: [\"\", \"apps\", \"keycloak.org\"]\nresources: [\"persistentvolumeclaims\", \"deployments\", \"statefulsets\", \"keycloaks\", \"keycloakrealms\", \"keycloakusers\", \"keycloakclients\", \"keycloakbackups\"]\nverbs: [\"*\"]\n```\nPlease bear in mind this is intended to be used for internal purposes as there's no guarantee it'll work without any issues.\n\n#### Local Development\n| *Command* | *Description* |\n| ------------------------- | -------------------------------------------------------------------------------- |\n| `make setup` | Runs `setup/mod` `setup/githooks` `code/gen` |\n| `make setup/githooks` | Copys githooks from `./githooks` to `.git/hooks` |\n| `make setup/mod` | Resets the main module's vendor directory to include all packages |\n| `make setup/operator-sdk` | Installs the operator-sdk |\n| `make code/run` | Runs the operator locally for development purposes |\n| `make code/compile` | Builds the operator |\n| `make code/gen` | Generates/Updates the operator files based on the CR status and spec definitions |\n| `make code/check` | Checks for linting errors in the code |\n| `make code/fix` | Formats code using [gofmt](https://golang.org/cmd/gofmt/) |\n| `make code/lint` | Checks for linting errors in the code |\n\n#### CI\n| *Command* | *Description* |\n| ------------------- | -------------------------------------------------------------------------- |\n| `make setup/travis` | Downloads operator-sdk, makes it executable and copys to `/usr/local/bin/` |\n\n#### Components versions\n\nAll images used by the Operator might be controlled using dedicated Environmental Variables:\n\n | *Image* | *Environment variable* | *Default* |\n | ------------------- | ------------------------------- | ---------------------------------------------------------------- |\n | `Keycloak` | `RELATED_IMAGE_KEYCLOAK` | `quay.io/keycloak/keycloak:9.0.2` |\n | `RHSSO` for OpenJ9 | `RELATED_IMAGE_RHSSO_OPENJ9` | `registry.redhat.io/rh-sso-7/sso74-openshift-rhel8:7.4-1` |\n | `RHSSO` for OpenJDK | `RELATED_IMAGE_RHSSO_OPENJDK` | `registry.redhat.io/rh-sso-7/sso74-openshift-rhel8:7.4-1` |\n | Init container | `RELATED_IMAGE_KEYCLOAK_INIT_CONTAINER` | `quay.io/keycloak/keycloak-init-container:master` |\n | Backup container | `RELATED_IMAGE_RHMI_BACKUP_CONTAINER` | `quay.io/integreatly/backup-container:1.0.10` |\n | Postgresql | `RELATED_IMAGE_POSTGRESQL` | `registry.redhat.io/rhel8/postgresql-10:1` |\n\n## Contributing\n\nBefore contributing to Keycloak Operator please read our [contributing guidelines](CONTRIBUTING.md).\n\n## Other Keycloak Projects\n\n* [Keycloak](https://github.com/keycloak/keycloak) - Keycloak Server and Java adapters\n* [Keycloak Documentation](https://github.com/keycloak/keycloak-documentation) - Documentation for Keycloak\n* [Keycloak QuickStarts](https://github.com/keycloak/keycloak-quickstarts) - QuickStarts for getting started with Keycloak\n* [Keycloak Docker](https://github.com/jboss-dockerfiles/keycloak) - Docker images for Keycloak\n* [Keycloak Gatekeeper](https://github.com/keycloak/keycloak-gatekeeper) - Proxy service to secure apps and services with Keycloak\n* [Keycloak Node.js Connect](https://github.com/keycloak/keycloak-nodejs-connect) - Node.js adapter for Keycloak\n* [Keycloak Node.js Admin Client](https://github.com/keycloak/keycloak-nodejs-admin-client) - Node.js library for Keycloak Admin REST API\n\n## License\n\n* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",59718952,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",269470,"full_size",59712330,"id",124628090,"images",[101],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"architecture","amd64","digest","sha256:146ad182b06714dbfcd8483a71e866a0b75fbac0292a6ab8faf62b0efef92b96","features","last_pulled","2026-09-27T08:29:10.718126983Z","last_pushed","2020-11-05T09:23:07Z","os","linux","os_features","os_version","size","variant","2020-11-05T09:23:06.273751Z","last_updater","last_updater_username","media_type","latest","repository",10171159,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":11,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

rckrdstrgrd/keycloak-operator

Tags for rckrdstrgrd/keycloak-operator