-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from MarkEWaite/convert-docs-to-github
Revise documentation
- Loading branch information
Showing
4 changed files
with
72 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,46 @@ | ||
| This plugin makes it possible to copy artifacts to remote locations. | ||
| # Artifact Deployer Plugin | ||
|
|
||
| # History and Objectives | ||
| This plugin makes it possible to copy artifacts to remote locations. | ||
|
|
||
| By default, Jenkins archives artifacts generated by the build. These | ||
| artifacts are stored in the JENKINS\_HOME directory with all other | ||
| elements such as job configuration files. | ||
| There is no separation between infrastructure elements, project elements | ||
| and outputs. | ||
| It is often considered to be a bad practice, and it doesn't help to | ||
| manage JENKINS\_HOME directory from an administrator point of view | ||
| (backup issues, etc). | ||
| By default, Jenkins archives artifacts generated by the build. | ||
| These artifacts are stored in the `JENKINS_HOME` directory with all other elements such as job configuration files. | ||
| There is no separation between infrastructure elements, project elements and outputs. | ||
| It is often considered to be a bad practice and it doesn't help to manage the `JENKINS_HOME` directory from an administrator point of view (backup issues, etc). | ||
| And for now, we can't change the 'Archived artifacts' location. | ||
|
|
||
| ArtifactDeployer plugin enables you to archive build artifacts to any | ||
| remote locations such as to a separate file server (outside of | ||
| JENKINS\_HOME directory). | ||
| the `JENKINS_HOME` directory). | ||
|
|
||
| There are many other Jenkins plugins close to ArtifactDeployer such as | ||
| [CopyArtifact | ||
| plugin](https://plugins.jenkins.io/copyartifact/) for | ||
| [CopyArtifact plugin](https://plugins.jenkins.io/copyartifact/) for | ||
| publishing artifacts from Jenkins resources (from the current workspace, | ||
| from the old builds of the same job or other jobs, ...) to remote | ||
| locations with the protocol file:// | ||
| locations with the protocol file:// | ||
| There are also others plugins for managing other protocols such as | ||
| ftp://, ssh:///. | ||
| ftp://, ssh://. | ||
|
|
||
| But none of these plugins provides a common way to manage the | ||
| deployment. | ||
| But none of these plugins provides a common way to manage the deployment. | ||
|
|
||
| ArtifactDeployer is a complete alternative to the built-in Jenkins | ||
| feature 'Archiving artefacts' and it is aimed at providing uniform | ||
| deployment mechanisms. | ||
| feature "Archiving artifacts' and it is aimed at providing an uniform | ||
| deployment mechanism. | ||
|
|
||
| # Features | ||
|
|
||
| - Copies build artifacts from the workspace to a remote location | ||
| shared on the build processor node | ||
| - Provides links to archived artefacts from the job status page | ||
| - Provides links to archived artifacts from the job status page | ||
| - Deletes on demand archived artifacts when the build is removed | ||
|
|
||
| # Limitations | ||
|
|
||
| - Only file deployment is supported | ||
| - For downloading deployed artifacts, remote location must be | ||
| accessible from the Jenkins master | ||
| accessible from the Jenkins controller | ||
| - Jenkins process must have the right permissions to write in the | ||
| specified location | ||
|
|
||
| # Changelog | ||
|
|
||
| See the separate [change log](CHANGELOG.md) for past releases. |
6 changes: 3 additions & 3 deletions
6
...resources/org/jenkinsci/plugins/artifactdeployer/ArtifactDeployerBuilder/help-remote.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| <div> | ||
| <p> | ||
| Artifacts will be deployed in the specified output directory.<br/> | ||
| The remote location must be accessible through the build machine (master/slave node).<br/> | ||
| The remote location must be accessible through the build machine (controller and agent node).<br/> | ||
| If you want to have the ability to download deployed artifacts through the Jenkins dashboard, | ||
| the location must be accessible from the Jenkins master.<br/> | ||
| the location must be accessible from the Jenkins controller.<br/> | ||
| Make sure the Jenkins process have the right permissions to write to the remote location.<br/> | ||
| For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine. | ||
| For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine. | ||
| </p> | ||
| </div> |
6 changes: 3 additions & 3 deletions
6
...sources/org/jenkinsci/plugins/artifactdeployer/ArtifactDeployerPublisher/help-remote.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| <div> | ||
| <p> | ||
| Artifacts will be deployed in the specified output directory.<br/> | ||
| The remote location must be accessible through the build machine (master/slave node).<br/> | ||
| The remote location must be accessible through the build machines (the controller and the agents).<br/> | ||
| If you want to have the ability to download deployed artifacts through the Jenkins dashboard, | ||
| the location must be accessible from the Jenkins master. <br/> | ||
| the location must be accessible from the Jenkins controller. <br/> | ||
| Make sure the Jenkins process have the right permissions to write to the remote location.<br/> | ||
| For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine. | ||
| For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine. | ||
| </p> | ||
| </div> |