Package: k8srad
Kubernetes-Ready RAD (K8SRAD)Rapid Application Development is a software development principle to use pre-given frequently needed components of an software application to accelerate the software development
process massively.
These components are for example functions for user authentication and authorization, user management (self-registration of a user, deactivating an account)
but also application designs. With the usage of pre-given component a lot of development tasks are omitted which rapidly accelerates the software development.YOTRON put this development principles one step ahead and uses aKubernetes-ready Rapid Application Developmentframework.
The Kubernetes deployment is integrated part of the software development, means the software we provide for you is Kubernetes-Ready out-of-the-box.This is the default application, which is the starting point of the Rapid Application Development. Please see thedescription.URLsThe project contains code, build packages, container ... . Below an overview:TypeProviderURLKubernetes-Ready RADyotron.dehttps://www.yotron.de/blog/kuberentesreadyrad/Containerhub.docker.comhttps://hub.docker.com/r/yotronpublic/k8sradPython Package (PyPi)pypi.orghttps://pypi.org/project/k8srad/HELM packageartifacthub.io / helm.yotron.dehttps://artifacthub.io/packages/helm/yotron-helm-charts/k8sradInstallationWe provide two installation methods. A native installation on any OS which supports Python3 and a installation in Kubernetes via HELM.
Per default, K8SRAD runs on a sqlite database. Sqlite is recommended only for testing and on a standalone installation.In production, you should use a PostgreSQL database for a better data persistency and to allow a HA setup with more K8SRAD nodes.The K8SRAD has no TLS-termination ("https"). We recommend to use a Reverse Proxy like NGINX or Apache Web Server in front of K8SRAD Web App for TLS termination.The HELM project of K8SRAD for Kubernetes contains all needed and recommended components. You can optionally install a NGINX Reverse Proxy and a PostgreSQL database with the project,
but you can also use separated applications.NativePrerequisitesPython3Python-pipfor dependency installationOpenLDAP for LDAP authenticationSSL for secured LDAP authenticationrecommended: python3-venv to create a virtual environment for Python3recommended:PostgreSQLdatabase for the K8SRAD metadatarecommended: A reverse proxy with TLS termination (e.g. NGINX).Prerequisites Python and pipK8SRAD supports all current Python3 versions. It is tested with Python 3.9.x and 3.10.xTo check which Python version is running:vagrant@bullseye:~$ python3 -V
Python 3.9.2To check which Pip version is running:vagrant@bullseye:~$ pip3 -V
pip 20.3.4 from /home/vagrant/k8srad/lib/python3.9/site-packages/pip (python 3.9)It is possible, that in your distribution Python must be called withpythonandpip.If you need a Python installation from the scratch. Python3, Pip3 and python3-venv are available in the main OS distribution.For Debian/Ubuntu:sudo apt-get install python3 python3-pip python3-venvFor RedHat/CentOS:sudo yum install python3 python3-pip python3-venvPrerequisites OpenLDAP and SSLFor authentication packages for authentication like OpenLDAP and SSL are neededFor Debian/Ubuntu:sudo apt-get install libsasl2-dev python-dev libldap2-dev libssl-devFor RedHat/CentOS:sudo yum install python-devel openldap-develInstallationThere are a lot of variants how to start a Python web project. We use a Python virtual environment for setting up K8SRAD on a virtual environment.
Depend on your environment and knowledge in Python the process can be different.Create a virtual environment of PythonCreate a virtual environment for K8SRADvagrant@bullseye:~$ python3 -m venv venvActivate your virtual environmentThis steps is to repeat every time you want to restart K8SRAD.vagrant@bullseye:~$ source venv/bin/activate
(venv) vagrant@bullseye:~$Install all Python dependencies needed for the project:(k8srad) vagrant@bullseye:~$ pip install k8srad --upgradeStart K8SRAD server(k8srad) vagrant@bullseye:~$ k8srad-run --host=0.0.0.0 --port=8080
2022-10-06 15:21:07,382:INFO:flask_appbuilder.base:Registering class View on menu 
...
2022-10-10 11:18:22,385:INFO:flask_appbuilder.baseviews:Registering route / ('GET',)
2022-10-10 11:18:22,424:INFO:waitress:Serving on http://0.0.0.0:8080Open Browser and start K8SRAD with one of the IPs mentioned above:Your will automatically redirected tohttp://x.x.x.x:8080/loginLogin as a admin userThe default credentials for the admin user are:Username: adminPassword: adminPlease see themanualto allow access to buckets.HELMYou find the installation instructions for KuberneteshereManualThe manual for K8SRAD you findhereConfigurationThe dotenv file andK8SRAD_CONF_FILEvariableYou can customize K8SRAD with a setting defined in a dotenv file. The dotenv file can be chosen freely and you can put the file in a folder of your choice but
the file must be reachable by the K8SRAD App.Additionally, you need a environment variableK8SRAD_CONF_FILEwith the path to your config file.For example, for Linux you can set the environment variable with:export K8SRAD_CONF_FILE=/etc/k8srad/.k8sradwith.k8sradas the dotenv file name.The file contains setting to the following topics:customization of your K8SRADAuthenticationThe parameter of the config fileKubernetes RADnameexampledescriptionpossible valuesdefaultK8SRAD_APP_NAMEMy Fancy Kuberrentes AppThe name of your K8SRAD. It is display in the head of your application.K8SRAD_APP_ICONhttps://myserver.com/my_own_logo.svgThe icon of your K8SRAD as a html link. It is display in the head of your application.K8SRAD_LOG_LEVELinfoLogLevel for the Logging.fatal, error, warning, info, debuginfoK8SRAD_LOG_FILE/var/log/k8srad.logWhen set logs are written to the mentioned file. If not set it is written to console (stdout).not setK8SRAD_DB_TYPEpostgresqlType of database to use. Can be a SQLite or a PostgreSQL Databasesqlite, postgressqliteK8SRAD_PG_DB_HOSTk8s-1.mydatabse.comOnly if db-type postgres: Host name of the PostresSQL server.K8SRAD_PG_DB_PORT5432Only if db-type postgres: Port number of the PostresSQL server.5432K8SRAD_PG_DB_NAMEk8sradOnly if db-type postgres: Name of the PostgreSQL Database.K8SRAD_PG_DB_USER_NAMEk8sradOnly if db-type postgres: Username to authenticate against the PostgreSQL DatabaseK8SRAD_PG_DB_USER_PWk8sradOnly if db-type postgres: Password to authenticate against the PostgreSQL DatabaseK8SRAD_SECRET_KEYthisIsMyHiddenSecretKeyA key which used to sign session cookies for protection against cookie data tampering. In production please change it.Authentication generalnameexampledescriptionpossible valuesdefaultK8SRAD_AUTH_TYPEdatabaseParameter to define the authentication method. It can be an authentication via LDAP or via the default database with name and password.ldap, databasedatabaseAUTH_USER_REGISTRATIONParameter to define if a user can self registrate to K8SRAD. With LDAP it must be set to True.True, FalseFalseAUTH_USER_REGISTRATION_ROLEDefault role a user, when registered or authenticated via LDAP firstly.Public, AdminPublicAUTH_ROLES_MAPPINGMapping a LDAP group onto a K8SRAD roleAdminandPublic.K8SRAD_SESSION_LIFETIME1800Seconds of inactivity after which a user must re-login.600Example of a role mappingAUTH_ROLES_MAPPING = {
    "cn=k8suser,ou=groups,dc=example,dc=com": ["Public"],
    "cn=k8sradadmins,ou=groups,dc=example,dc=com": ["Admin"],
}Authentication LDAPTo allow authentication with LDAP, a LDAP group must be mapped onto one the K8SRAD RolePublicorAdmin.nameexampledescriptionpossible valuesdefaultAUTH_LDAP_SERVERldap://ldap.example.comThe URL of the LDAP server.AUTH_LDAP_USE_TLSFalseIf the LDAP server allows TLS secured communication set to True.True, FalseAUTH_LDAP_FIRSTNAME_FIELDgivenNameName of the field of the person LDAP entity with the given name.AUTH_LDAP_LASTNAME_FIELDsnName of the field of the person LDAP entity with the last name.AUTH_LDAP_EMAIL_FIELDemailName of the field of the person LDAP entity with the email address.AUTH_LDAP_USERNAME_FORMATuid=%s,ou=users,dc=example,dc=comDistinguished name of the user to authenticate.%swill be replaced by the username of the K8SRAD login.AUTH_LDAP_APPEND_DOMAINexample.comWhen a username always has a domain appendix.AUTH_LDAP_SEARCHou=users,dc=example,dc=comLDAP search string if a user is part of an organizational unit.AUTH_LDAP_UID_FIELDuidWhen using a LDAP search the filed name with the username of the organizational unit.AUTH_LDAP_BIND_USERldapadminThe bind user used for authentication against LDAP.AUTH_LDAP_BIND_PASSWORDmyHiddenPasswordThe password of the bin user sed for authentication against LDAP.AUTH_LDAP_SEARCH_FILTER(memberOf=cn=myTeam,ou=teams,dc=example,dc=com)Filter the user which are allowed to access K8SRAD generally.AUTH_LDAP_GROUP_FIELDmemberOfWhen using AUTH_ROLES_MAPPING the name of the field with the role DN.You find further information about how to configure LDAP against Microsoft AD or OpenLDAPhere.The start parameterTo start of the K8SRAD server simply callk8srad-runas shown above. You have has the following parameter:nameshortexampledescriptiondefaultHOST-s, --host127.0.0.1Listener Host IP. 0.0.0.0 for all IPs.0.0.0.0PORT-P, --port8090Listener Host Port8080THREADS-t --threads1Threads for parallelization4Withk8srad-run -hyou get the possible configuration:(k8srad) vagrant@bullseye:~$ k8srad-run -h
...
usage: k8srad-run [-h] [-s HOST] [-p PORT] [-t THREADS]
Start parameter for the K8SRAD web server.
optional arguments:
-h, --help            show this help message and exit
-s HOST, --host HOST  Listener Host IP. Default: 0.0.0.0
-p PORT, --port PORT  Listener Host Port. Default: 8080.
-t THREADS, --threads THREADS  Threads for parallelization. Default: 4.