Skip to content

Commit

Permalink
Update README to describe changes to the MBS properties in the config…
Browse files Browse the repository at this point in the history
…uration file.
  • Loading branch information
mmathesius committed Apr 19, 2021
1 parent 46416af commit c99dc69
Showing 1 changed file with 46 additions and 6 deletions.
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,22 +98,31 @@ configuration:
cgi: https://src.fedoraproject.org/repo/pkgs/upload.cgi
path: "%(name)s/%(filename)s/%(hashtype)s/%(hash)s/%(filename)s"
profile: koji
mbs: https://mbs.fedoraproject.org
destination:
scm: ssh://pkgs.example.com/
cache:
url: http://pkgs.example.com/repo
cgi: http://pkgs.example.com/lookaside/upload.cgi
path: "%(name)s/%(filename)s/%(hashtype)s/%(hash)s/%(filename)s"
profile: brew
mbs: https://mbs.example.com
mbs:
api_url: https://mbs.example.com/module-build-service/1/
auth_method: oidc
oidc_id_provider: https://id.example.com/openidc/
oidc_client_id: mbs-authorizer
oidc_client_secret: notsecret
oidc_scopes:
- openid
- https://id.example.com/scope/groups
- https://mbs.example.com/oidc/submit-build
trigger:
rpms: rawhide
modules: rawhide-modular
build:
prefix: git://pkgs.example.com/
target: fluff-42.0.0-alpha-candidate
scratch: false
platform: platform:fl42
git:
author: DistroBaker
email: [email protected]
Expand Down Expand Up @@ -191,8 +200,6 @@ passed to pyrpkg defining the file path used by this particular cache.
configuration must be available on the host, along with the necessary
certificates.

`mbs` is a stub link to the MBS instance. This is currently unused.

Example:

```yaml
Expand All @@ -203,7 +210,6 @@ source:
cgi: https://src.fedoraproject.org/repo/pkgs/upload.cgi
path: "%(name)s/%(filename)s/%(hashtype)s/%(hash)s/%(filename)s"
profile: koji
mbs: https://mbs.fedoraproject.org
```

##### `destination`
Expand All @@ -212,7 +218,38 @@ The `destination` block configures the downstream destination source control
and cache. DistroBaker needs write access to both to effectively sync
components.

The structure is the same as that of the `source` block.
The structure is the same as that of the `source` block plus the addition of a
mandatory `mbs` block.

The `mbs` block configures the MBS instance used for building modules. It must
always contain `api_url` and `auth_method` properties. `auth_method` must be
`kerberos` or `oidc`. When `auth_method` is `oidc`, additional
`oidc_id_provider`, `oidc_client_id`, `oidc_client_secret`, and `oidc_scopes`
properties must be provided. The values to use for the `mbs` sub-properties
can be taken directly from the `[<profile>.mbs]` section of the appropriate
`/etc/rpkg/<profile>.conf` (eg., `/etc/rpkg/centpkg.conf`) file.

Example:

```yaml
destination:
scm: ssh://pkgs.example.com/
cache:
url: http://pkgs.example.com/repo
cgi: http://pkgs.example.com/lookaside/upload.cgi
path: "%(name)s/%(filename)s/%(hashtype)s/%(hash)s/%(filename)s"
profile: brew
mbs:
api_url: https://mbs.example.com/module-build-service/1/
auth_method: oidc
oidc_id_provider: https://id.example.com/openidc/
oidc_client_id: mbs-authorizer
oidc_client_secret: notsecret
oidc_scopes:
- openid
- https://id.example.com/scope/groups
- https://mbs.example.com/oidc/submit-build
```

##### `trigger`

Expand Down Expand Up @@ -242,13 +279,16 @@ system can access. Could be read-only.
The `target` property defines the destination build system target. Targets are
buildroot and destination tag tuples.

The `platform` property defines the destination module build system target platform in `<name>:<stream>` format.

Example:

```yaml
build:
prefix: git://pkgs.example.com/
target: fluff-42.0.0-alpha-candidate
scratch: false
platform: platform:fl42
```

##### `git`
Expand Down

0 comments on commit c99dc69

Please sign in to comment.