Text of pkg.go.dev › github.3367457833.workers.dev › aerogear › unifiedpush-operator as Styx crawled it on Oct 8, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

unifiedpush-operator module - github.3367457833.workers.dev/aerogear/unifiedpush-operator - Go Packages

README ¶ :toc: :toc-placement!: // gEmoji for admonitions, see // https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74#admonitions ifdef::env-github[] :status: :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :table-caption!: :warning-caption: :warning: endif::[] // Links (alphabetical order) :apache_license: http://www.apache.org/licenses/LICENSE-2.0[Apache License, Version 2.0] :application_monitoring_operator: https://github.com/integr8ly/application-monitoring-operator[application-monitoring-operator] :code_of_conduct: link:CODE_OF_CONDUCT.md[Contributor Code of Conduct] :export_policy: https://aerogear.org/legal/export.html[AeroGear Export Policy] :aerogear_freenode: irc://irc.freenode.net/aerogear[#aerogear on FreeNode IRC] :aerogear_jira: https://issues.jboss.org/projects/AEROGEAR/issues[AeroGear on JBoss Jira] :aerogear_matrix: https://matrix.to/#/!IipcvbGVqkiTUQauSC:matrix.org[#aerogear:matrix.org on Matrix] :mailing_list: https://groups.google.com/forum/#!forum/aerogear[Google Groups Mailing List] :minishift: https://github.com/minishift/minishift[Minishift] :rh_product_security: https://access.redhat.com/security/team/contact[Red Hat Product Security team] = UnifiedPush Operator ifdef::status[] .*Project health* image:https://circleci.com/gh/aerogear/unifiedpush-operator.svg?style=svg[Build Status (CircleCI), link=https://circleci.com/gh/aerogear/unifiedpush-operator] image:https://img.shields.io/:license-Apache2-blue.svg[License (License), link=http://www.apache.org/licenses/LICENSE-2.0] image:https://coveralls.io/repos/github/aerogear/unifiedpush-operator/badge.svg?branch=master[Coverage Status (Coveralls), link=https://coveralls.io/github/aerogear/unifiedpush-operator?branch=master] image:https://goreportcard.com/badge/github.com/aerogear/unifiedpush-operator[Go Report Card (Go Report Card), link=https://goreportcard.com/report/github.com/aerogear/unifiedpush-operator] endif::[] toc::[] == Overview The UnifiedPush Operator for Kubernetes provides an easy way to install and manage an https://aerogear.org/docs/unifiedpush/[AeroGear UnifiedPush] Server on OpenShift. == Prerequisites |=== |https://golang.org/doc/install[Install Go] |https://github.com/golang/go/wiki/SettingGOPATH[Ensure the $GOPATH environment variable is set] |https://golang.github.io/dep/docs/installation.html[Install the dep package manager] |https://github.com/operator-framework/operator-sdk#quick-start[Install Operator-SDK] |https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl[Install kubectl] |=== == Getting Started === Cloning the repository By the following commands you will create a local directory and clone this project. [source,shell] ---- $ git clone git@github.com:aerogear/unifiedpush-operator.git $GOPATH/src/github.com/aerogear/unifiedpush-operator ---- === Minishift installation and setup https://docs.okd.io/latest/minishift/getting-started/installing.html[Install Minishift] then install Operators on it by running the following commands. [source,shell] ---- # create a new profile to test the operator $ minishift profile set unifiedpush-operator # enable the admin-user add-on $ minishift addon enable admin-user # add insecure registry to download the images from docker $ minishift config set insecure-registry 172.30.0.0/16 # start the instance $ minishift start ---- NOTE: The above steps are not required in OCP > 4 since the OLM and Operators came installed by default. === Installing Use the following command to install the UnifiedPush Operator and Service in your OpenShift cluster as follows: [source,shell] ---- $ make install ---- IMPORTANT: It will install an example configuration setup for your Push Server.

To know how to configure it see <<UnifiedPushServer Options>> NOTE: To install you need be logged in as a user with cluster privileges like the `system:admin` user. E.g. By using: `oc login -u system:admin`. === Uninstalling Use the following command to delete all related configuration applied by the `make install` of this project. [source,shell] ---- $ make cluster/clean ---- NOTE: To uninstall you need be logged in as a user with cluster privileges like the `system:admin` user.

E.g. By using: `oc login -u system:admin`. == Configuration === UnifiedPushServer Options This is the main installation resource kind. Creation of a valid UnifiedPushServer CR will result in a functional AeroGear UnifiedPushServer deployed to your namespace. [NOTE] ==== This operator currently only supports one UnifiedPushServer CR to be created. ==== Here are all of the configurable fields in a UnifiedPushServer: .UnifiedPushServer fields |=== |Field Name |Description |Default |backups |A list of backup entries that CronJobs will be created from.

See `./deploy/crds/push_v1alpha1_unifiedpushserver_cr_with_backup.yaml` for an annotated example. Note that a ServiceAccount called "backupjob" must already exist before the operator will create any backup CronJobs. See https://github.com/integr8ly/backup-container-image/tree/master/templates/openshift/rbac for an example. | No backups |useMessageBroker |Can be set to true to use managed queues, if you are using enmasse. |false |unifiedPushResourceRequirements |Unified Push Service container resource requirements. a| [source,yaml] ---- limits: memory: "<value of UPS_MEMORY_LIMIT passed to operator>" cpu: "<value of UPS_CPU_LIMIT passed to operator>" requests: memory: "<value of UPS_MEMORY_REQUEST passed to operator>" cpu: "<value of UPS_CPU_REQUEST passed to operator>" ---- |oAuthResourceRequirements |OAuth Proxy container resource requirements. a| [source,yaml] ---- limits: memory: "<value of OAUTH_MEMORY_LIMIT passed to operator>" cpu: "<value of OAUTH_CPU_LIMIT passed to operator>" requests: memory: "<value of OAUTH_MEMORY_REQUEST passed to operator>" cpu: "<value of OAUTH_CPU_REQUEST passed to operator>" ---- |postgresResourceRequirements |Postgres container resource requirements. a| [source,yaml] ---- limits: memory: "<value of POSTGRES_MEMORY_LIMIT passed to operator>" cpu: "<value of POSTGRES_CPU_LIMIT passed to operator>" requests: memory: "<value of POSTGRES_MEMORY_REQUEST passed to operator>" cpu: "<value of POSTGRES_CPU_REQUEST passed to operator>" ---- |postgresPVCSize |PVC size for Postgres service |Value of `POSTGRES_PVC_SIZE` environment variable passed to operator |=== The most basic UnifiedPushServer CR doesn't specify anything in the Spec section, so the example in `./deploy/crds/push_v1alpha1_unifiedpushserver_cr.yaml` is a good template: .push_v1alpha1_unifiedpushserver_cr.yaml [source,yaml] ---- apiVersion: push.aerogear.org/v1alpha1 kind: UnifiedPushServer metadata: name: example-unifiedpushserver ---- To create this, you can run: .... kubectl apply -n unifiedpush -f ./deploy/crds/push_v1alpha1_unifiedpushserver_cr.yaml ....

To see the created instance then, you can run: .... kubectl get ups example-unifiedpushserver -n unifiedpush -o yaml .... === Defaults for resource sizes, limits and requests As described in the section above, it is possible to define memory, cpu and volume limits and requests in the UnifiedPushServer CR. However, operator will use some defaults that are passed to operator as environment variables, if no value is specified in the CR.

If no environment variable is also passed to operator, operator will use some hardcoded values. Here are these variables: .Defaults for resource sizes, limits and requests |=== |Variable |Default value |`UPS_MEMORY_LIMIT` |`2Gi` |`UPS_MEMORY_REQUEST` |`512Mi` |`UPS_CPU_LIMIT` |`1` |`UPS_CPU_REQUEST` |`500m` |`OAUTH_MEMORY_LIMIT` |`64Mi` |`OAUTH_MEMORY_REQUEST` |`32Mi` |`OAUTH_CPU_LIMIT` |`20m` |`OAUTH_CPU_REQUEST` |`10m` |`POSTGRES_MEMORY_LIMIT` |`512Mi` |`POSTGRES_MEMORY_REQUEST` |`256Mi` |`POSTGRES_CPU_LIMIT` |`1` |`POSTGRES_CPU_REQUEST` |`250m` |`POSTGRES_PVC_SIZE` |`5Gi` |=== === Container Names If you would like to modify the container names, you can

The rest of this page is on the live site.