NCM::Component::download - schema

Types

  • /software/components/download/component_download_file
    • /software/components/download/component_download_file/href

      • Description: A URL (either absolute, or relative) that describes the source of the file. The URL can be specified as relative by ommitting the server name and/or the protocol, in which case the component defaults will be used. Local files can be used as source, such as file://localhost/etc/foo.txt or even file:///etc/foo.txt.

      • Required

      • Type: string

    • /software/components/download/component_download_file/post

      • Description: Specify the command (no options allowed) to run after non-failed download attempt. The filename is added as first and (only) argument. Note that if the update is optimised away by the download process (e.g. if the file is already up-to-date), the command will still be executed, so it is the responsibility of this command to determine what work needs to be done, if any.

      • Optional

      • Type: string

    • /software/components/download/component_download_file/proxy

      • Description: If false, then the proxy configuration will be ignored for this file. This has no effect when there are no proxy hosts defined.

      • Required

      • Type: boolean

      • Default value: true

    • /software/components/download/component_download_file/gssapi

      • Description: If true, then curl/LWP will be invoked with GSSAPI Negotiate extension enabled, using the host keytab as the identity.

      • Optional

      • Type: boolean

    • /software/components/download/component_download_file/perm

      • Description: Sets the permissions of the file to the defined permissions (defined in octal, e.g. 0644).

      • Optional

      • Type: string

    • /software/components/download/component_download_file/owner

      • Description: Sets the ownership to given user (name or number).

      • Optional

      • Type: string

    • /software/components/download/component_download_file/group

      • Description: Sets the group ownership to the given group (name or number).

      • Optional

      • Type: string

    • /software/components/download/component_download_file/min_age

      • Description: Don’t consider the remote file to be new until it is this number of minutes old

      • Required

      • Type: long

      • Default value: 0

    • /software/components/download/component_download_file/cacert

      • Optional

      • Type: string

    • /software/components/download/component_download_file/capath

      • Optional

      • Type: string

    • /software/components/download/component_download_file/cert

      • Optional

      • Type: string

    • /software/components/download/component_download_file/key

      • Optional

      • Type: string

    • /software/components/download/component_download_file/timeout

      • Description: seconds, overrides setting in component

      • Optional

      • Type: long

    • /software/components/download/component_download_file/allow_older

      • Description: allow older remote file

      • Optional

      • Type: boolean

    • /software/components/download/component_download_file/daemons

      • Description: A dict of daemonname => caf_serviceaction indicating what actions should be applied to daemonname if the file changes. This allows, for example, the restarting of a daemon upon file change. Even if multiple services are associated to the same daemon, each action for the daemon will be taken at most once. If multiple actions are to be taken for the same daemon, all actions will be taken (no attempt to optimize is made).

      • Optional

      • Type: caf_serviceaction

  • /software/components/download/download_component
    • /software/components/download/download_component/server

      • Description: The default server hostname to use for any sources which do not specify the source.

      • Optional

      • Type: string

    • /software/components/download/download_component/proto

      • Description: The default protocol to use for any sources which do not specify the protocol.

      • Optional

      • Type: string

    • /software/components/download/download_component/files

      • Description: An dict of escaped filenames required for the destination file.

      • Optional

      • Type: component_download_file

    • /software/components/download/download_component/proxyhosts

      • Description: List of hostnames (and possibly with ‘:port’ suffix). When specified, a reverse proxy configuration is assumed for all of the file sources. Whenever a file is downloaded, each of the proxy hosts will be used first before attempting the original source URL. The first proxy host to respond will be used for all subsequent download attempts.

      • Optional

      • Type: type_hostport

    • /software/components/download/download_component/head_timeout

      • Description: seconds, timeout for HEAD requests which checks for changes

      • Optional

      • Type: long

    • /software/components/download/download_component/timeout

      • Description: seconds, total timeout for fetch of file, can be overridden per file

      • Optional

      • Type: long

    • /software/components/download/download_component/kinit_args

      • Description: argumensts to be passed in kinit -k called in ncm-download

      • Optional

      • Type: string