set-maintenance

Set Maintenance On

Sets repositories into ‘maintenance mode’.

When a repository is in maintenance mode, publishing onto customer- visible locations should be forbidden.

usage: pubtools-pulp-maintenance-on [-h] [--debug] [--pulp-url PULP_URL]
                                    [--pulp-user PULP_USER]
                                    [--pulp-password PULP_PASSWORD]
                                    [--pulp-certificate PULP_CERTIFICATE]
                                    [--pulp-certificate-key PULP_CERTIFICATE_KEY]
                                    [--pulp-insecure]
                                    [--pulp-throttle PULP_THROTTLE]
                                    [--pulp-fake] [--owner OWNER]
                                    [--repo-url-regex REPO_URL_REGEX]
                                    [--repo-ids REPO_IDS] [--message MESSAGE]

Named Arguments

--debug, -d

Show debug logs; can be provided up to three times to enable more logs

Default: 0

--owner

who sets/unsets maintenance mode

--repo-url-regex

adjust maintenance mode for repositories with a publish URL matching this pattern

--repo-ids

comma separated repositories to be set/unset to maintenance mode

--message

Describes why set to maintenance mode

Pulp environment

--pulp-url

Pulp server URL

--pulp-user

Pulp username

--pulp-password

Pulp password (or set PULP_PASSWORD environment variable)

--pulp-certificate

Pulp certificate. Can also be a single file (.pem)

--pulp-certificate-key

Pulp certificate key

--pulp-insecure

Allow unverified HTTPS connection to Pulp

Default: False

--pulp-throttle

Allows to enqueue or run only specified number of Pulp tasks at one moment (or set PULP_THROTTLE environment variable)

--pulp-fake

Use a fake in-memory Pulp client rather than interacting with a real server. For development/testing only, may have limited functionality.

Default: False

Example

A typical invocation of set maintenance would look like this:

pubtools-pulp-maintenance-on \
  --pulp-url https://pulp.example.com/ \
  --pulp-user admin \
  --pulp-password XXXXX \
  --repo-ids example-repo

In this example, the repository with id ‘example-repo’ will be set to maintenance mode.

Set Maintenance Off

Unset repositories maintenance mode.

usage: pubtools-pulp-maintenance-off [-h] [--debug] [--pulp-url PULP_URL]
                                     [--pulp-user PULP_USER]
                                     [--pulp-password PULP_PASSWORD]
                                     [--pulp-certificate PULP_CERTIFICATE]
                                     [--pulp-certificate-key PULP_CERTIFICATE_KEY]
                                     [--pulp-insecure]
                                     [--pulp-throttle PULP_THROTTLE]
                                     [--pulp-fake] [--owner OWNER]
                                     [--repo-url-regex REPO_URL_REGEX]
                                     [--repo-ids REPO_IDS]

Named Arguments

--debug, -d

Show debug logs; can be provided up to three times to enable more logs

Default: 0

--owner

who sets/unsets maintenance mode

--repo-url-regex

adjust maintenance mode for repositories with a publish URL matching this pattern

--repo-ids

comma separated repositories to be set/unset to maintenance mode

Pulp environment

--pulp-url

Pulp server URL

--pulp-user

Pulp username

--pulp-password

Pulp password (or set PULP_PASSWORD environment variable)

--pulp-certificate

Pulp certificate. Can also be a single file (.pem)

--pulp-certificate-key

Pulp certificate key

--pulp-insecure

Allow unverified HTTPS connection to Pulp

Default: False

--pulp-throttle

Allows to enqueue or run only specified number of Pulp tasks at one moment (or set PULP_THROTTLE environment variable)

--pulp-fake

Use a fake in-memory Pulp client rather than interacting with a real server. For development/testing only, may have limited functionality.

Default: False

Example

A typical invocation of unset maintenance would look like this:

pubtools-pulp-maintenance-off \
  --pulp-url https://pulp.example.com/ \
  --pulp-user admin \
  --pulp-password XXXXX \
  --repo-ids example-repo

In this example, the repository with id ‘example-repo’ will be removed from maintenance mode.