Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.82 KB

configurationReload.md

File metadata and controls

32 lines (26 loc) · 1.82 KB
Raw

Triggering Configuration Reload

You have the following option to trigger a configuration reload:

  • via the user interface: Manage Jenkins -> Configuration -> Reload existing configuration
  • via http POST to JENKINS_URL/configuration-as-code/reload Note: this needs to include a valid CRUMB and authentication information e.g. username + token of a user with admin permissions. Since Jenkins 2.96 CRUMB is not needed for API tokens.
  • via Jenkins CLI: with the Jenkins CLI (either with SSH or JAR), the command java -jar jenkins-cli.jar -s ${JENKINS_URL} reload-jcasc-configuration triggers a configuration reload. This Jenkins CLI command is only present when the plugin configuration-as-code is installed, and reported in the help message:
$ java -jar jenkins-cli.jar -s ${JENKINS_URL} help
# ...
reload-jcasc-configuration
    Reload JCasC YAML configuration
# ...

  • via http POST to JENKINS_URL/reload-configuration-as-code It's disabled by default and secured via a token configured as system property casc.reload.token. Setting the system property enables this functionality and the requests need to include the token as query parameter named casc-reload-token, i.e. JENKINS_URL/reload-configuration-as-code/?casc-reload-token=32424324rdsadsa.

    curl -X POST "JENKINS_URL:8080/reload-configuration-as-code/?casc-reload-token=32424324rdsadsa"

  • via Groovy script (not recommended)

    import io.jenkins.plugins.casc.ConfigurationAsCode
ConfigurationAsCode.get().configure()

    Note: that running the above code in a pipeline will put this plugin in a bad state where the configuration cannot be reloaded at all until Jenkins is restarted. See #1227 for more info.