Nubus for Kubernetes - Customization and Modification Manual 1.x

How-to for Nextcloud

3.8. How-to for Nextcloud#

This section provides a how-to for building a packaged integration using Nextcloud as an example. After reading this section, you know how to use the various plugins described in Packaged integrations to create a packaged integration to connect Nextcloud to Nubus for Kubernetes. It focuses on the following objectives:

  1. The Portal Service provides a tile that links to the Nextcloud instance.

  2. Nextcloud uses Nubus for Kubernetes as its identity management source. Identity administrators can use Nubus to decide which user accounts or user groups may use Nextcloud.

  3. The entire configuration is distributable as a packaged integration.

This section addresses software developers for the steps to create the packaged integration. In a second part, it addresses DevOps engineers for the steps on installing the packaged integration.

This how-to takes you along the following steps:

Software developers

  1. Validate that you meet the Requirements.

  2. Create the Packaged integration directory structure.

  3. Prepare the plugins.

  4. Bundle the plugins in a container image as packaged integration.

  5. Publish packaged integration.

  6. Communicate packaged integration.

3.8.1. Requirements#

To go through this how-to you need a computer where you can create a directory structure and files. You need the knowledge listed in Audience and required knowledge.

3.8.2. Packaged integration directory structure#

Before you begin, ensure that you meet the requirements as outlined in Requirements.

To begin with this how-to, you need to create the directory structure in Listing 3.13 on your local machine. The directory contains all the necessary files for the packaged integration.

Listing 3.13 Project directory structure for Nextcloud packaged integration#
nextcloud-packaged-integration/
├── docker
└── plugins

You can use a different top-level directory name. However, keep the directories docker and plugins as they are for consistency reasons.

You can turn the directory structure into a repository for your source code management system to track all the changes over time.

3.8.3. Prepare the plugins#

Before you continue, ensure that you have completed the steps in Packaged integration directory structure.

The packaged integration for Nextcloud uses various plugins for Nubus for Kubernetes. This section describes how you create and add these plugins to the directory structure.

  1. Add LDAP schemas.

  2. Add extended attributes for Nextcloud.

  3. Add LDAP search user so that Nextcloud can access the Directory Service.

  4. Create tile for Portal Service that points users to Nextcloud.

3.8.3.1. Add LDAP schemas#

An LDAP schema defines the data model in the Directory Service. This plugin type allows extending the data model to store additional information with an object. For more information, see LDAP schema.

Identity administrators can control which user or user group may access Nextcloud. They can also define how much disk space a user may allocate. Operators can then configure Nextcloud to evaluate these attributes. Therefore, the Nextcloud packaged integration provides an LDAP schema to add application specific attributes and object classes to achieve these use cases.

To add the LDAP schema, use the following steps:

  1. Create the directory ldap-schema/ in your plugins/ directory.

  2. Add the file nextcloud.schema to the ldap-schema/ directory with the content in Listing 3.14. The schema adds the following LDAP elements:

    Attributes

    • univentionNextcloudEnabled

    • univentionNextcloudQuota

    Object classes

    • univentionNextcloudUser

    • univentionNextcloudGroup

    Listing 3.14 LDAP schema for the Nextcloud packaged integration#
    # Attribute Types
#-----------------

attributetype ( 1.3.6.1.4.1.10176.99999.00424.10 NAME 'univentionNextcloudEnabled'
        DESC 'whether user or group should be available in Nextcloud'
        EQUALITY caseIgnoreMatch
        SUBSTR caseIgnoreSubstringsMatch
        SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE)

attributetype ( 1.3.6.1.4.1.10176.99999.00424.11 NAME 'univentionNextcloudQuota'
        DESC 'defines how much disk space is available for the user'
        EQUALITY caseIgnoreMatch
        SUBSTR caseIgnoreSubstringsMatch
        SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE)

# Object Classes
#---------------

objectclass ( 1.3.6.1.4.1.10176.99999.00424.12 NAME 'univentionNextcloudUser'
        DESC 'A Nextcloud user'
        SUP top AUXILIARY
        MUST ( cn  )
        MAY ( univentionNextcloudEnabled $ univentionNextcloudQuota )
        )

objectclass ( 1.3.6.1.4.1.10176.99999.00424.13 NAME 'univentionNextcloudGroup'
        DESC 'A Nextcloud group'
        SUP top AUXILIARY
        MUST ( cn  )
        MAY ( univentionNextcloudEnabled )
        )

Your directory structure looks like Listing 3.15.

Listing 3.15 Directory structure with LDAP schemas#
nextcloud-packaged-integration/
├── docker
└── plugins
    └── ldap-schema
        └── nextcloud.schema

3.8.3.2. Add extended attributes#

Extended attributes are a feature of UDM which provides a mapping between an input widget and a UDM attribute. The UDM HTTP REST API configures extended attributes. The UDM data loader plugin automates the configuration process of extended attributes for the Nextcloud packaged integration. For more information about the UDM data loader, see UDM data loader.

To add an extended attribute, use the following steps:

  1. Create the directory udm-data-loader/ in your plugins/ directory.

  2. Add the 86_Nextcloud.yaml file to the udm-data-loader/ directory with the content in Listing 3.16.

    Take a look at the first extended attribute with the name univentionNextcloudEnabled. The attribute has the property default. It’s emphasized in the listing. In this case, default: "TRUE" means that UDM automatically allows newly created users to access Nextcloud, if univentionNextcloudEnabled wasn’t set explicitly when the user was created.

    Note

    The 86_Nextcloud.yaml file that you can download here, includes more data than shown in Listing 3.16. Section 3.8.3.3 to Section 3.8.3.4 explain the remaining content of the file in detail.

    Listing 3.16 Definition for extended attributes in YAML format for the UDM data loader#
    ---
# Create container for Nextcloud custom attributes
action: create
module: container/cn
position: cn=custom attributes,cn=univention,{{ ldapBaseDn }}
properties:
  name: "nextcloud"
---
# Create extended attribute Nextcloud for user
action: create
module: settings/extended_attribute
position: cn=nextcloud,cn=custom attributes,cn=univention,{{ ldapBaseDn }}
properties:
  name: "univentionNextcloudEnabled"
  CLIName: nextcloudEnabled
  ldapMapping: univentionNextcloudEnabled
  module: ["users/user"]
  shortDescription: Access to Nextcloud
  overwriteTab: False
  valueRequired: False
  tabName: NextCloud Hub
  syntax: "boolean"
  multivalue: False
  tabPosition: 1
  tabAdvanced: False
  overwritePosition: "0"
  doNotSearch: False
  hook: 'None'
  mayChange: True
  deleteObjectClass: False
  default: "TRUE"
  objectClass: univentionNextcloudUser
---
# Create extended attribute Nextcloud Quota for user
action: create
module: settings/extended_attribute
position: cn=nextcloud,cn=custom attributes,cn=univention,{{ ldapBaseDn }}
properties:
  name: "univentionNextcloudUserQuota"
  CLIName: nextcloudQuota
  ldapMapping: univentionNextcloudQuota
  module: ["users/user"]
  shortDescription: "Nextcloud Quota"
  longDescription: "Amount of storage available to the user (ex: 512 MB or 12 GB)"
  tabName: NextCloud Hub
  overwriteTab: False
  valueRequired: False
  syntax: 'string'
  default: ""
  tabAdvanced: False
  mayChange: True
  multivalue: False
  deleteObjectClass: False
  tabPosition: 1
  overwritePosition: "0"
  doNotSearch: False
  hook: 'None'
  objectClass: univentionNextcloudUser
---
# Create extended attribute Nextcloud for group
action: create
module: settings/extended_attribute
position: cn=nextcloud,cn=custom attributes,cn=univention,{{ ldapBaseDn }}
properties:
  name: "univentionNextcloudGroupEnabled"
  CLIName: nextcloudEnabled
  ldapMapping: univentionNextcloudEnabled
  module: ["groups/group"]
  shortDescription: "Available in Nextcloud"
  longDescription: "The group is available in Nextcloud"
  tabName: NextCloud Hub
  overwriteTab: False
  valueRequired: False
  syntax: 'boolean'
  default: "0"
  tabAdvanced: False
  mayChange: True
  multivalue: False
  deleteObjectClass: False
  tabPosition: 1
  overwritePosition: "0"
  doNotSearch: False
  hook: 'None'
  objectClass: univentionNextcloudGroup

3.8.3.3. Add LDAP search user#

Applications like Nextcloud read the list of users from the Directory Service. OpenLDAP is the Directory Service in Nubus. To access the Directory Service and read directory objects, it’s best practice to use a separate user account for each application. Each application uses its own user account to search for users in the Directory Service through LDAP. Therefore, the documentation usually refers to this user account with the term LDAP search user.

You need to use the UDM data loader plugin to add the LDAP search user to Nubus. The UDM data loader uses the UDM HTTP REST API to create the directory objects through UDM. For more information about the UDM data loader, see UDM data loader.

To add the LDAP search user, open the 86_Nextcloud.yaml file in the plugins/udm-data-loader/ directory and add the content in Listing 3.17. The UDM data loader creates the LDAP search user in the users/ldap UDM module. Unlike the users/user UDM module which addresses identity administrators to manage user accounts that represent people, the users/ldap UDM module hides the LDAP search user from the user account and user group management in the Management UI.

Note the template variable nextcloudUserPassword.

Caution

Don’t hard code the user password for the LDAP search user. The UDM data loader provides a template mechanism and uses Jinja2. Using a template variable allows the operator to choose their own password when installing the packaged integration.

Tip

You can use the template mechanism to also make other values configurable. For more information, see Template variables in the data loader.

Listing 3.17 Definition for LDAP search user for Nextcloud in YAML format for the UDM data loader#
---
# Create Nextcloud service user
action: create
module: users/ldap
position: cn=users,{{ ldapBaseDn }}
properties:
  username: "nextcloudUser"
  lastname: "LDAP-system-User"
  password: {{ nextcloudUserPassword }}
  overridePWHistory: true
  overridePWLength: true

See also

Identity Store and Directory Service

in Univention Nubus for Kubernetes - Architecture Manual [1] for information about the architecture of the Identity Store and Directory Service in Nubus for Kubernetes.

3.8.3.4. Create tile for Portal Service#

A portal tile adds a link to Nextcloud on the Portal Service so that end users have a direct navigation to Nextcloud. Adding a portal tile comprises the following actions:

  1. Create a portal tile, define its appearance, behavior, and visibility.

  2. Add the portal tile to a portal category where the Portal Service shows it.

Important

The Portal Service only shows portal tiles that have a reference entry in the portal category.

A portal tile is also a directory object. To add the portal tile, you need to use the UDM data loader plugin. Open the 86_Nextcloud.yaml file in the plugins/udm-data-loader/ directory and add the content in Listing 3.18.

Note the template variables portalNextcloudLinkBase and ldapBaseDn. Similar to the password for the LDAP Search user in Add LDAP search user, the operator must set the value for portalNextcloudLinkBase upon the installation of the packaged integration. Nubus for Kubernetes provides the value for ldapBaseDn by default so that the operator doesn’t have to set the value for it. For more information about the template mechanism, see Template variables in the data loader.

properties.icon contains the Base64-encoded data of the Nextcloud icon for the portal tile.

Listing 3.18 Definition for the portal tile for Nextcloud in YAML format for the UDM data loader#
---
# Create Nextcloud portal tile
action: create_or_modify
module: portals/entry
position: cn=entry,cn=portals,cn=univention,{{ ldapBaseDn }}
properties:
  name: "nextcloud"
  icon: "<svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="Layer_1" width="141.485" height="99.603" x="0" y="0" enable-background="new 0 0 196.6 72" version="1.1" viewBox="0 0 132.642 93.377" xml:space="preserve"><metadata id="metadata20"/><defs id="defs18"><clipPath id="clipPath8812" clipPathUnits="userSpaceOnUse"><circle id="circle8814" cx="95.669" cy="95.669" r="79.724" style="fill:#00080d;fill-opacity:1;stroke-width:1"/></clipPath></defs><path id="path1052" d="m 66.407896,9.375 c -11.805271,0 -21.811217,8.003196 -24.912392,18.846621 -2.695245,-5.751517 -8.535934,-9.780938 -15.263394,-9.780938 -9.25185,0 -16.85711,7.605263 -16.85711,16.857108 0,9.251833 7.60526,16.860567 16.85711,16.860567 6.72746,0 12.568149,-4.031885 15.263395,-9.784412 3.101175,10.84425 13.10712,18.850106 24.912391,18.850106 11.717964,0 21.67289,-7.885111 24.853382,-18.607048 2.745036,5.621934 8.513436,9.541354 15.145342,9.541354 9.25185,0 16.86057,-7.608734 16.86057,-16.860567 0,-9.251845 -7.60872,-16.857108 -16.86057,-16.857108 -6.631906,0 -12.400306,3.916965 -15.145342,9.537891 C 88.080786,17.257475 78.12586,9.375 66.407896,9.375 Z m 0,9.895518 c 8.911648,0 16.030748,7.115653 16.030748,16.027273 0,8.911605 -7.1191,16.030737 -16.030748,16.030737 -8.911593,0 -16.027247,-7.119132 -16.027247,-16.030737 0,-8.91162 7.115653,-16.027271 16.027247,-16.027273 z M 26.23211,28.336202 c 3.90438,0 6.96505,3.057188 6.96505,6.961589 0,3.904386 -3.06067,6.965049 -6.96505,6.965049 -3.90439,0 -6.96161,-3.060663 -6.96161,-6.965049 0,-3.904401 3.05722,-6.961589 6.96161,-6.961589 z m 80.17451,0 c 3.90442,0 6.96506,3.057188 6.96506,6.961589 0,3.904386 -3.06066,6.965049 -6.96506,6.965049 -3.90436,0 -6.961576,-3.060663 -6.961576,-6.965049 0,-3.904401 3.057226,-6.961589 6.961576,-6.961589 z" style="color:#000;font-style:normal;font-variant:normal;font-weight:400;font-stretch:normal;font-size:medium;line-height:normal;font-family:sans-serif;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;baseline-shift:baseline;text-anchor:start;white-space:normal;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000;solid-opacity:1;fill:#0082c9;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:5.56590033;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:10;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"/><path style="fill:#0082c9;fill-opacity:1;stroke-width:.47038522" id="path1174" d="m 21.235693,69.043756 c -0.32926,0 -0.47147,0.187936 -0.47147,0.517242 V 83.20368 c 0,0.32927 0.14221,0.51495 0.47147,0.51495 h 0.37763 c 0.32927,0 0.51494,-0.18568 0.51494,-0.51495 V 71.874833 l 7.4473,11.557727 c 0.0324,0.0505 0.0677,0.0842 0.10299,0.12123 0.0106,0.0125 0.0179,0.0256 0.0298,0.0366 0.0317,0.0289 0.0665,0.044 0.10065,0.0618 0.019,0.01 0.0338,0.0247 0.055,0.032 0.0148,0.005 0.0304,0.002 0.0458,0.006 0.0525,0.0135 0.10618,0.0275 0.16936,0.0275 h 0.37534 c 0.32926,0 0.47146,-0.18567 0.47146,-0.51495 V 69.560768 c 0,-0.329305 -0.1422,-0.517241 -0.47146,-0.517241 h -0.37534 c -0.32929,0 -0.51724,0.187936 -0.51724,0.517241 V 80.89011 l -7.4473,-11.557716 c -0.0254,-0.03939 -0.0561,-0.06339 -0.0847,-0.0939 -0.086,-0.121611 -0.2222,-0.194545 -0.41654,-0.194545 z m 89.420157,0.187676 c -0.32926,0 -0.18767,0.187956 -0.18767,0.517241 v 4.657417 c 0,0.47037 0.0456,0.79872 0.0456,0.79872 h -0.0456 c 0,0 -0.89419,-2.06893 -3.38722,-2.06893 -2.72821,0 -4.65771,2.16372 -4.56357,5.36231 0,3.19862 1.74024,5.41041 4.51551,5.41041 2.68118,0 3.5749,-2.16508 3.5749,-2.16508 h 0.048 c 0,0 -0.0939,0.28283 -0.0939,0.65913 v 0.79874 c 0,0.32926 0.18796,0.47148 0.51726,0.47148 h 0.32955 c 0.32927,0 0.46917,-0.18798 0.46917,-0.51724 V 69.748673 c 0,-0.329285 -0.51754,-0.517241 -0.84681,-0.517241 z m -36.549859,0.0481 c -0.329276,0 -0.13961,0.187976 -0.13961,0.517241 V 81.32017 c 0,2.25783 1.503766,2.54039 2.350463,2.54039 0.376301,0 0.517217,-0.18796 0.517217,-0.51721 v -0.32958 c 0,-0.32926 -0.188212,-0.46918 -0.423394,-0.46918 -0.470405,-0.047 -1.080249,-0.18887 -1.080249,-1.50594 V 69.79677 c 0,-0.329266 -0.517531,-0.517241 -0.846807,-0.517241 z M 57.220266,70.50169 c -0.32927,0 -0.517238,0.187975 -0.517238,0.51724 v 2.44659 1.17638 5.31423 c 0,2.44599 1.365105,3.81064 3.622946,3.81064 0.42334,0 0.563011,-0.13993 0.563011,-0.46918 v -0.2838 c 0,-0.37629 -0.139671,-0.47024 -0.563011,-0.51724 -0.799652,-0.047 -2.258905,-0.32912 -2.258905,-2.72809 v -5.17464 h 2.117009 c 0.329268,0 0.517238,-0.1399 0.517238,-0.46918 v -0.1419 c 0,-0.32926 -0.18797,-0.51722 -0.517238,-0.51722 h -2.117009 v -2.44659 c 0,-0.329265 -0.139909,-0.51724 -0.469177,-0.51724 z m -18.734963,2.63427 c -2.82229,0 -5.08192,2.02359 -5.12888,5.41037 0,3.19859 2.35289,5.40809 5.41039,5.40809 1.646328,0 2.86852,-0.70495 3.432986,-1.12831 0.23526,-0.18814 0.283014,-0.42392 0.141896,-0.65912 l -0.141896,-0.23346 c -0.141115,-0.28223 -0.374612,-0.33005 -0.656846,-0.14188 -0.470383,0.37629 -1.413295,0.94064 -2.730371,0.94064 -2.116709,0 -3.951319,-1.50604 -3.998279,-4.14019 h 7.479331 c 0.282247,0 0.517238,-0.23501 0.517238,-0.51725 0,-2.9634 -1.550291,-4.93889 -4.325569,-4.93889 z m 29.223883,0 c -3.057482,0 -5.409203,2.25755 -5.456161,5.45614 0,3.1986 2.352896,5.41039 5.410387,5.41039 1.881541,0 3.151307,-0.89493 3.668718,-1.31828 0.235262,-0.2352 0.280729,-0.42265 0.139619,-0.7049 L 71.33213,81.79165 c -0.188136,-0.28225 -0.376902,-0.33005 -0.659131,-0.14191 -0.470383,0.42334 -1.457552,1.08255 -2.915751,1.08255 -2.257826,0 -4.046348,-1.69419 -4.046348,-4.14019 0,-2.49302 1.788522,-4.18596 4.046348,-4.18596 1.223008,0 2.115816,0.61137 2.58618,0.94065 0.282241,0.18807 0.516748,0.18838 0.704913,-0.0938 l 0.1419,-0.23572 c 0.235271,-0.28224 0.187125,-0.51677 -0.0481,-0.7049 -0.517422,-0.42337 -1.645515,-1.17638 -3.432986,-1.17638 z m 15.899301,0 c -3.010451,0 -5.456156,2.30482 -5.456156,5.36231 0,3.10451 2.445705,5.45615 5.456156,5.45615 3.010478,0 5.456168,-2.35164 5.456168,-5.45615 0,-3.05749 -2.44569,-5.36231 -5.456168,-5.36231 z m -30.429991,0.15793 c -0.11518,0.0184 -0.226037,0.0959 -0.331857,0.22197 l -1.904164,2.26805 -1.423546,1.69818 -2.158205,-2.57015 -1.169505,-1.39608 c -0.105876,-0.12611 -0.225795,-0.19525 -0.350163,-0.20597 -0.124354,-0.01 -0.253796,0.0361 -0.379919,0.14189 l -0.288371,0.24258 c -0.252223,0.21167 -0.23901,0.44583 -0.02745,0.69807 l 1.904166,2.26803 1.579172,1.88357 -2.311543,2.75326 c -0.0024,0.002 -0.0035,0.005 -0.0046,0.006 l -1.167215,1.38923 c -0.211653,0.25223 -0.188132,0.51842 0.06408,0.73009 l 0.288368,0.2403 c 0.252239,0.21164 0.481813,0.15841 0.693465,-0.0939 l 1.901876,-2.26806 1.425834,-1.69818 2.158204,2.57244 c 10e-4,0.002 0.0035,0.004 0.0046,0.005 l 1.164928,1.3915 c 0.211652,0.25223 0.477834,0.27337 0.730081,0.0617 l 0.288371,-0.2403 c 0.252237,-0.21165 0.239134,-0.44581 0.02746,-0.69805 l -1.904161,-2.27034 -1.579177,-1.88129 2.311546,-2.75554 c 0.0024,-0.002 0.0035,-0.004 0.0046,-0.006 l 1.167214,-1.38921 c 0.211651,-0.25224 0.188132,-0.51844 -0.06408,-0.73009 l -0.288371,-0.2403 c -0.126112,-0.10587 -0.246408,-0.14655 -0.361607,-0.12815 z m 38.662308,0.0779 c -0.32928,0 -0.47148,0.18796 -0.47148,0.51723 v 6.06722 c 0,2.6812 1.9757,3.99829 4.42169,3.99829 2.446,0 4.421696,-1.31709 4.421696,-3.99829 v -6.06723 c 0.047,-0.32926 -0.13991,-0.51723 -0.469176,-0.51723 h -0.37763 c -0.32927,0 -0.51724,0.18797 -0.51724,0.51723 v 5.69189 c 0,1.59931 -1.035,3.05766 -3.05765,3.05766 -1.9756,0 -3.05763,-1.45835 -3.05763,-3.05766 v -5.69189 c 0,-0.32926 -0.18797,-0.51723 -0.51726,-0.51723 z m -53.403561,0.94063 c 1.505226,0 2.82161,1.08155 2.915753,3.24531 h -6.490633 c 0.32927,-2.11674 1.83447,-3.24531 3.57488,-3.24531 z m 45.171244,0.0939 c 2.210809,0 3.998303,1.74023 3.998303,4.09214 0,2.44598 -1.787494,4.23401 -3.998303,4.23401 -2.210781,0 -3.999385,-1.83505 -4.046332,-4.23401 0,-2.30488 1.835551,-4.09214 4.046332,-4.09214 z m 23.566303,0 c 2.21082,0 3.29339,2.02346 3.29339,4.1402 0,2.9634 -1.60102,4.18595 -3.34144,4.18595 -1.92856,0 -3.24413,-1.6459 -3.29108,-4.18595 0,-2.63415 1.50465,-4.1402 3.33913,-4.1402 z"/></svg>"
  link:
    - - en_US
      - {{ portalNextcloudLinkBase }}/apps/files
  allowedGroups:
    - 'cn=Domain Users,cn=groups,{{ ldapBaseDn }}'
    - 'cn=Domain Admin,cn=groups,{{ ldapBaseDn }}'
  linkTarget: newwindow
  description:
    de_DE: Dateien verwalten, bearbeiten und teilen
    en_US: Manage, edit and share files
  displayName:
    de_DE: Nextcloud
    en_US: Nextcloud
---
action: ensure_list_contains
module: portals/category
position: cn=domain-service,cn=category,cn=portals,cn=univention,{{ ldapBaseDn }}
properties:
  entries:
  - cn=nextcloud,cn=entry,cn=portals,cn=univention,{{ ldapBaseDn }}
...

Your directory structure looks like Listing 3.19.

Listing 3.19 Directory structure with plugins for Nextcloud packaged integration#
nextcloud-packaged-integration/
├── docker
└── plugins
    ├── ldap-schema
    │   └── nextcloud.schema
    └── udm-data-loader
        └── 86_Nextcloud.yaml

3.8.4. Build container image#

After you prepared the plugins for the packaged integration, it’s time to bundle them in a container image. This section follows the steps outlined in Bundle packaged integrations and applies them to the Nextcloud packaged integration.

To bundle the packaged integration, use the following steps:

  1. Create the Dockerfile in the docker/ directory with the content in Listing 3.20.

    Listing 3.20 Dockerfile for creating the container image for the packaged integration#
    # SPDX-License-Identifier: AGPL-3.0-only
# SPDX-FileCopyrightText: 2024 - 2025 Univention GmbH

ARG BASE_IMAGE_TAG=3.20
ARG BASE_IMAGE=docker.io/alpine
FROM ${BASE_IMAGE}:${BASE_IMAGE_TAG}

# Create system group and system user
RUN addgroup -S appgroup && adduser -S appuser -G appgroup
USER appuser

WORKDIR /

# Copy plugins of the packaged integration to the Docker image
COPY plugins /plugins
# Copy the plugin loader to the Docker image
COPY docker/loader.sh /bin/loader

CMD ["/bin/loader"]

  2. Create the loader.sh loader script in the docker/ directory with the content in Listing 3.21. For information about the loader, see Packaged integration loader.

    Listing 3.21 Loader script for copying the plugins to the target directory during installation#
    #!/bin/sh
# SPDX-License-Identifier: AGPL-3.0-only
# SPDX-FileCopyrightText: 2024 - 2025 Univention GmbH

set -eu

echo "Copying the Nubus plugins into the /target volume"
for source in /plugins/*; do
  plugin_type=$(basename "${source}")
  target="/target/${plugin_type}"
  if [ -d "${target}" ]; then
    echo "COPY - Plugin type ${plugin_type} in /target, copying files."
    cp -av "${source}" /target
  else
    echo "SKIP - Plugin type ${plugin_type} not in /target, skipping."
  fi
done

    Finally, your directory structure looks like Listing 3.22.

    Listing 3.22 Directory structure with Dockerfile, loader, and plugins#
    nextcloud-packaged-integration/
├── docker
│   ├── Dockerfile
│   └── loader.sh
└── plugins
    ├── ldap-schema
    │   └── nextcloud.schema
    └── udm-data-loader
        └── 86_Nextcloud.yaml

  3. To build the container image, run the commands in Listing 3.23.

    Listing 3.23 Example for building the container image for the packaged integration#
    $ export IMAGE_NAME="nextcloud"

$ cd nextcloud-packaged-integration
$ docker build -t "$IMAGE_NAME" -f docker/Dockerfile .

3.8.5. Publish packaged integration#

To make the packaged integration available for Nubus for Kubernetes, you need to publish it to a container registry where your intended audience has access to.

To publish your container image, use the commands from the example in Listing 3.24.

Listing 3.24 Example for publishing container image with bundled packaged integration#
$ export REGISTRY="artificts.software-univention.de"
$ export REPOSITORY="nubus/images/nextcloud-packaged-integration"
$ export IMAGE_NAME="nextcloud"
$ export IMAGE_TAG="0.1.0"

$ docker image tag "$IMAGE_NAME" "$REGISTRY"/"$REPOSITORY"/"$IMAGE_NAME":"$IMAGE_TAG"
$ docker image push "$REGISTRY"/"$REPOSITORY"/"$IMAGE_NAME":"$IMAGE_TAG"

The environment variables used in Listing 3.24 need to reflect the host and folder structure of your container registry. An operator later uses them in their Helm values when referring to the container image of the packaged integration. Table 3.2 shows the mapping.

Table 3.2 Term mapping and description for used environment variables#

Environment variable

Description

Helm Chart key

REGISTRY

FQDN and optional port of your container registry

registry

REPOSITORY

PATH to the image on the registry without trailing slash /

repository

IMAGE_NAME

The name of the container image

name

IMAGE_TAG

Your version tag or latest

tag

3.8.6. Communicate packaged integration#

You need to tell operators that want to install your packaged integration, where they can find the container image, what each template variable is for, and which values each variable accepts. Provide an example. This how-to defines the following template variables that you need to communicate:

nextcloudUserPassword

The operator must define a dedicated password for the LDAP search user. They must use the same password in the Nextcloud LDAP configuration for the search user.

portalNextcloudLinkBase

The operator must set the base URL to their Nextcloud instance, for example https://nextcloud.example.com.

Tip

You don’t need to communicate the ldapBaseDn template variable, because Nubus for Kubernetes automatically fills in the value during installation.

On this page