Skip to main content

KubraGen Builder: Keycloak

Project description

KubraGen Builder: Keycloak

PyPI version Supported Python versions

kg_keycloak is a builder for KubraGen that deploys a Keycloak server in Kubernetes.

KubraGen is a Kubernetes YAML generator library that makes it possible to generate configurations using the full power of the Python programming language.

Example

from kubragen import KubraGen
from kubragen.consts import PROVIDER_GOOGLE, PROVIDERSVC_GOOGLE_GKE
from kubragen.object import Object
from kubragen.option import OptionRoot
from kubragen.options import Options
from kubragen.output import OutputProject, OD_FileTemplate, OutputFile_ShellScript, OutputFile_Kubernetes, \
    OutputDriver_Print
from kubragen.provider import Provider

from kg_keycloak import KeycloakBuilder, KeycloakOptions

kg = KubraGen(provider=Provider(PROVIDER_GOOGLE, PROVIDERSVC_GOOGLE_GKE), options=Options({
    'namespaces': {
        'mon': 'app-monitoring',
    },
}))

out = OutputProject(kg)

shell_script = OutputFile_ShellScript('create_gke.sh')
out.append(shell_script)

shell_script.append('set -e')

#
# OUTPUTFILE: app-namespace.yaml
#
file = OutputFile_Kubernetes('app-namespace.yaml')

file.append([
    Object({
        'apiVersion': 'v1',
        'kind': 'Namespace',
        'metadata': {
            'name': 'app-monitoring',
        },
    }, name='ns-monitoring', source='app', instance='app')
])

out.append(file)
shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

shell_script.append(f'kubectl config set-context --current --namespace=app-monitoring')

#
# SETUP: keycloak
#
keycloak_config = KeycloakBuilder(kubragen=kg, options=KeycloakOptions({
    'namespace': OptionRoot('namespaces.mon'),
    'basename': 'mykeycloak',
    'config': {
        'service_port': 80,
        'proxy_address_forwarding': True,
        'admin': {
            'user': 'test@example.com',
            'password': 'mypassword',
        },
    },
    'kubernetes': {
        'resources': {
            'deployment': {
                'requests': {
                    'cpu': '150m',
                    'memory': '300Mi'
                },
                'limits': {
                    'cpu': '300m',
                    'memory': '450Mi'
                },
            },
        },
    }
}))

keycloak_config.ensure_build_names(keycloak_config.BUILD_CONFIG, keycloak_config.BUILD_SERVICE)

#
# OUTPUTFILE: keycloak-config.yaml
#
file = OutputFile_Kubernetes('keycloak-config.yaml')
out.append(file)

file.append(keycloak_config.build(keycloak_config.BUILD_CONFIG))

shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

#
# OUTPUTFILE: keycloak.yaml
#
file = OutputFile_Kubernetes('keycloak.yaml')
out.append(file)

file.append(keycloak_config.build(keycloak_config.BUILD_SERVICE))

shell_script.append(OD_FileTemplate(f'kubectl apply -f ${{FILE_{file.fileid}}}'))

#
# Write files
#
out.output(OutputDriver_Print())
# out.output(OutputDriver_Directory('/tmp/build-gke'))

Output:

****** BEGIN FILE: 001-app-namespace.yaml ********
apiVersion: v1
kind: Namespace
metadata:
  name: app-monitoring

****** END FILE: 001-app-namespace.yaml ********
****** BEGIN FILE: 002-keycloak-config.yaml ********
apiVersion: v1
kind: Secret
metadata:
  name: mykeycloak-config-secret
  namespace: app-monitoring
data:
  user: dGVzdEBleGFtcGxlLmNvbQ==
  password: bXlwYXNzd29yZA==

****** END FILE: 002-keycloak-config.yaml ********
****** BEGIN FILE: 003-keycloak.yaml ********
apiVersion: apps/v1
kind: Deployment
metadata:
  name: mykeycloak
  labels:
    app: mykeycloak
  namespace: app-monitoring
spec:
  selector:
    matchLabels:
      app: mykeycloak
<...more...>
****** END FILE: 003-keycloak.yaml ********
****** BEGIN FILE: create_gke.sh ********
#!/bin/bash

set -e
kubectl apply -f 001-app-namespace.yaml
kubectl config set-context --current --namespace=app-monitoring
kubectl apply -f 002-keycloak-config.yaml
kubectl apply -f 003-keycloak.yaml

****** END FILE: create_gke.sh ********

Credits

based on

keycloak/keycloak-quickstarts

Author

Rangel Reale (rangelspam@gmail.com)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kg_keycloak-0.7.8.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

kg_keycloak-0.7.8-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file kg_keycloak-0.7.8.tar.gz.

File metadata

  • Download URL: kg_keycloak-0.7.8.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.3

File hashes

Hashes for kg_keycloak-0.7.8.tar.gz
Algorithm Hash digest
SHA256 6be538811c1a0b737930472579084eca619c11c2c869a44ad218428576f8012f
MD5 44fb6c70cf6ca478ce2ba0dd37368022
BLAKE2b-256 9a71e03b4d342699bd7a7dff6059281cf05a8095a68edc096b6742c2cc376745

See more details on using hashes here.

File details

Details for the file kg_keycloak-0.7.8-py3-none-any.whl.

File metadata

  • Download URL: kg_keycloak-0.7.8-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.3

File hashes

Hashes for kg_keycloak-0.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8a0d0f139939a9f5bd3899f8d8c89710e6d14019be2c68b2b00f132b75a7810c
MD5 cbdbcad747ab039134a92262f42513e0
BLAKE2b-256 4b27c52b3437dd15155af18ac2c05d2a0c0993a9a46a67c5dbc970eefc047c22

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page