diff --git a/docs/dev/setup/bamboo-bitbucket-jira.rst b/docs/dev/setup/bamboo-bitbucket-jira.rst index d198da3c60c7..11e7bbb7605d 100644 --- a/docs/dev/setup/bamboo-bitbucket-jira.rst +++ b/docs/dev/setup/bamboo-bitbucket-jira.rst @@ -369,8 +369,8 @@ Configure Artemis server: port: 8080 # The port of artemis url: http://172.20.0.1:8080 # needs to be an ip - // url: http://docker.for.mac.host.internal:8080 # If the above one does not work for mac try this one - // url: http://host.docker.internal:8080 # If the above one does not work for windows try this one + # url: http://docker.for.mac.host.internal:8080 # If the above one does not work for mac try this one + # url: http://host.docker.internal:8080 # If the above one does not work for windows try this one In addition, you have to start Artemis with the profiles ``bamboo``, ``bitbucket`` and ``jira`` so that the correct adapters will be used, diff --git a/docs/dev/setup/jenkins-gitlab.rst b/docs/dev/setup/jenkins-gitlab.rst index 9c9e7f395c85..1390aec98bbb 100644 --- a/docs/dev/setup/jenkins-gitlab.rst +++ b/docs/dev/setup/jenkins-gitlab.rst @@ -125,11 +125,16 @@ both are set up correctly and follow these steps: INSERT INTO `artemis`.`jhi_user_authority` (`user_id`, `authority_name`) VALUES (1,"ROLE_ADMIN"); INSERT INTO `artemis`.`jhi_user_authority` (`user_id`, `authority_name`) VALUES (1,"ROLE_USER"); -4. Create a user in Gitlab (``http://your-gitlab-domain/admin/users/new``) and make sure that the username, -email, and password are the same as the user from the database: +4. Create a user in Gitlab (``http://your-gitlab-domain/admin/users/new``) and make sure that the username and +email are the same as the user from the database: .. figure:: setup/jenkins-gitlab/gitlab_admin_user.png +5. Edit the new admin user (``http://your-gitlab-domain/admin/users/artemis_admin/edit``) to set the password to the +same value as in the database: + +.. figure:: setup/jenkins-gitlab/gitlab_admin_user_password.png + Starting the Artemis server should now succeed. GitLab @@ -188,9 +193,9 @@ tokens instead of the predefined ones. :: - docker compose -f docker/.yml exec gitlab gitlab-rails runner "token = User.find_by_username('root').personal_access_tokens.create(scopes: [:api, :read_user, :read_api, :read_repository, :write_repository, :sudo], name: 'Artemis Admin Token'); token.set_token('artemis-gitlab-token'); token.save!" + docker compose -f docker/.yml exec gitlab gitlab-rails runner "token = User.find_by_username('root').personal_access_tokens.create(scopes: ['api', 'read_api', 'read_user', 'read_repository', 'write_repository', 'sudo'], name: 'Artemis Admin Token', expires_at: 365.days.from_now); token.set_token('artemis-gitlab-token'); token.save!" - | You can also manually create in by navigating to ``http://localhost:8081/-/profile/personal_access_tokens`` and + | You can also manually create in by navigating to ``http://localhost:8081/-/profile/personal_access_tokens?name=Artemis+Admin+token&scopes=api,read_api,read_user,read_repository,write_repository,sudo`` and generate a token with all scopes. | Copy this token into the ``ADMIN_PERSONAL_ACCESS_TOKEN`` field in the ``docker/gitlab/gitlab-local-setup.sh`` file. @@ -325,7 +330,7 @@ GitLab Access Token .. figure:: setup/jenkins-gitlab/gitlab_access_tokens_button.png :align: center -10. Create a new token named “Artemis” and give it **all** rights. +10. Create a new token named “Artemis” and give it rights ``api``, ``read_api``, ``read_user``, ``read_repository``, ``write_repository``, and ``sudo``. .. figure:: setup/jenkins-gitlab/artemis_gitlab_access_token.png :align: center @@ -469,7 +474,7 @@ do either do it manually or using the following command: :: - docker compose -f docker/.yml exec gitlab gitlab-rails runner "token = User.find_by_username('root').personal_access_tokens.create(scopes: [:api, :read_repository], name: 'Jenkins'); token.set_token('jenkins-gitlab-token'); token.save!" + docker compose -f docker/.yml exec gitlab gitlab-rails runner "token = User.find_by_username('root').personal_access_tokens.create(scopes: ['api', 'read_repository'], name: 'Jenkins', expires_at: 365.days.from_now); token.set_token('jenkins-gitlab-token'); token.save!" @@ -746,7 +751,7 @@ Choose “Download now and install after restart” and checking the Timestamper Configuration """"""""""""""""""""""""" -Go to *Manage Jenkins → Configure System*. There you will find the +Go to *Manage Jenkins → System Configuration → Configure*. There you will find the Timestamper configuration, use the following value for both formats: :: @@ -767,8 +772,8 @@ JUnit formatted results to any URL. You can download the current release of the plugin `here `__ (Download the **.hpi** file). Go to the Jenkins plugin page (*Manage -Jenkins → Manage Plugins*) and install the downloaded file under the -*Advanced* tab under *Upload Plugin* +Jenkins → System Configuration → Plugins*) and install the downloaded file under the +*Advanced settings* tab under *Deploy Plugin* .. figure:: setup/jenkins-gitlab/jenkins_custom_plugin.png :align: center @@ -776,7 +781,7 @@ Jenkins → Manage Plugins*) and install the downloaded file under the Jenkins Credentials """"""""""""""""""" -Go to *Manage Jenkins -> Security -> Manage Credentials → Jenkins → Global credentials* and create the +Go to *Manage Jenkins → Security → Credentials → Jenkins → Global credentials* and create the following credentials GitLab API Token @@ -798,7 +803,7 @@ GitLab API Token 4. Leave the ID field blank 5. The description is up to you -3. Go to the Jenkins settings *Manage Jenkins → Configure System*. There +3. Go to the Jenkins settings *Manage Jenkins → System*. There you will find the GitLab settings. Fill in the URL of your GitLab instance and select the just created API token in the credentials dropdown. After you click on “Test Connection”, everything should @@ -1013,7 +1018,8 @@ You can either run the builds locally (that means on the machine that hosts Jenk Configuring local build agents """""""""""""""""""""""""""""" -Go to `Manage Jenkins` > `Manage Nodes and Clouds` > `master` +Go to `Manage Jenkins` → `Nodes` → `Built-In Node` → `Configure` + Configure your master node like this (adjust the number of executors, if needed). Make sure to add the docker label. .. figure:: setup/jenkins-gitlab/jenkins_local_node.png @@ -1071,26 +1077,28 @@ Add agent in Jenkins: 1. Open Jenkins in your browser (e.g. localhost:8082) -2. Go to Manage Jenkins -> Manage Credentials -> (global) -> Add Credentials +2. Go to Manage Jenkins → Credentials → System → Global credentials (unrestricted) → Add Credentials - Kind: SSH Username with private key + - Scope: Global (Jenkins, nodes, items, all child items, etc) + - ID: leave blank - Description: Up to you - Username: jenkins - - Private Key: (e.g /root/.ssh/id_rsa) + - Private Key: (e.g /root/.ssh/id_rsa) - - Passphrase: (you can leave it blank if none has been specified) + - Passphrase: (you can leave it blank if none has been specified) .. figure:: setup/jenkins-gitlab/alternative_jenkins_node_credentials.png :align: center -3. Go to Manage Jenkins -> Manage Nodes and Clouds -> New Node +3. Go to Manage Jenkins → Nodes → New Node - - Node name: Up to you (e.g. Docker) + - Node name: Up to you (e.g. Docker agent node) - Check 'Permanent Agent' @@ -1223,10 +1231,10 @@ access control in Jenkins. This enables specific Artemis users to access build plans and execute actions such as triggering a build. This section explains the changes required in Jenkins in order to set up build plan access control: -1. Navigate to Manage Jenkins -> Manage Plugins -> Installed and make sure that you have the +1. Navigate to Manage Jenkins → Plugins → Installed plugins and make sure that you have the `Matrix Authorization Strategy `__ plugin installed -2. Navigate to Manage Jenkins -> Configure Global Security and navigate to the "Authorization" section +2. Navigate to Manage Jenkins → Security and navigate to the "Authorization" section 3. Select the "Project-based Matrix Authorization Strategy" option diff --git a/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_credentials.png b/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_credentials.png index 4901e0cd2cce..133b81583b92 100644 Binary files a/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_credentials.png and b/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_credentials.png differ diff --git a/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_setup.png b/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_setup.png index 29f5738eafb5..7eca324029fe 100644 Binary files a/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_setup.png and b/docs/dev/setup/jenkins-gitlab/alternative_jenkins_node_setup.png differ diff --git a/docs/dev/setup/jenkins-gitlab/artemis_gitlab_access_token.png b/docs/dev/setup/jenkins-gitlab/artemis_gitlab_access_token.png index 87c382c449e9..f99c0a490422 100644 Binary files a/docs/dev/setup/jenkins-gitlab/artemis_gitlab_access_token.png and b/docs/dev/setup/jenkins-gitlab/artemis_gitlab_access_token.png differ diff --git a/docs/dev/setup/jenkins-gitlab/gitlab_access_tokens_button.png b/docs/dev/setup/jenkins-gitlab/gitlab_access_tokens_button.png index e0ccc8e9ffaa..bdd5741b632d 100644 Binary files a/docs/dev/setup/jenkins-gitlab/gitlab_access_tokens_button.png and b/docs/dev/setup/jenkins-gitlab/gitlab_access_tokens_button.png differ diff --git a/docs/dev/setup/jenkins-gitlab/gitlab_admin_user.png b/docs/dev/setup/jenkins-gitlab/gitlab_admin_user.png index 7ea3865f73e5..f884f92a04d7 100644 Binary files a/docs/dev/setup/jenkins-gitlab/gitlab_admin_user.png and b/docs/dev/setup/jenkins-gitlab/gitlab_admin_user.png differ diff --git a/docs/dev/setup/jenkins-gitlab/gitlab_admin_user_password.png b/docs/dev/setup/jenkins-gitlab/gitlab_admin_user_password.png new file mode 100644 index 000000000000..7a9003dd9584 Binary files /dev/null and b/docs/dev/setup/jenkins-gitlab/gitlab_admin_user_password.png differ diff --git a/docs/dev/setup/jenkins-gitlab/gitlab_jenkins_token_rights.png b/docs/dev/setup/jenkins-gitlab/gitlab_jenkins_token_rights.png index 737b827b5880..2e3707db0503 100644 Binary files a/docs/dev/setup/jenkins-gitlab/gitlab_jenkins_token_rights.png and b/docs/dev/setup/jenkins-gitlab/gitlab_jenkins_token_rights.png differ diff --git a/docs/dev/setup/jenkins-gitlab/gitlab_preferences_button.png b/docs/dev/setup/jenkins-gitlab/gitlab_preferences_button.png index ba0bae2cf859..f106698f5557 100644 Binary files a/docs/dev/setup/jenkins-gitlab/gitlab_preferences_button.png and b/docs/dev/setup/jenkins-gitlab/gitlab_preferences_button.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_authorization_permissions.png b/docs/dev/setup/jenkins-gitlab/jenkins_authorization_permissions.png index 1dfcd3dfa26d..47b8e19a5be4 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_authorization_permissions.png and b/docs/dev/setup/jenkins-gitlab/jenkins_authorization_permissions.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_custom_plugin.png b/docs/dev/setup/jenkins-gitlab/jenkins_custom_plugin.png index 6223b74fdc40..aa8cb370489a 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_custom_plugin.png and b/docs/dev/setup/jenkins-gitlab/jenkins_custom_plugin.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_gitlab_configuration.png b/docs/dev/setup/jenkins-gitlab/jenkins_gitlab_configuration.png index 669cf01eb3f0..ac349efee7b7 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_gitlab_configuration.png and b/docs/dev/setup/jenkins-gitlab/jenkins_gitlab_configuration.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_local_node.png b/docs/dev/setup/jenkins-gitlab/jenkins_local_node.png index 4c6ceba8831b..8c1a9c20f55a 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_local_node.png and b/docs/dev/setup/jenkins-gitlab/jenkins_local_node.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_master_node.png b/docs/dev/setup/jenkins-gitlab/jenkins_master_node.png index e39e292e1784..48fe8c638a29 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_master_node.png and b/docs/dev/setup/jenkins-gitlab/jenkins_master_node.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_node.png b/docs/dev/setup/jenkins-gitlab/jenkins_node.png index 28fabdb3d9c9..77a89ef0b9ce 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_node.png and b/docs/dev/setup/jenkins-gitlab/jenkins_node.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_ssh_credentials.png b/docs/dev/setup/jenkins-gitlab/jenkins_ssh_credentials.png index f4b27958d527..9e127e1e193e 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_ssh_credentials.png and b/docs/dev/setup/jenkins-gitlab/jenkins_ssh_credentials.png differ diff --git a/docs/dev/setup/jenkins-gitlab/jenkins_test_project.png b/docs/dev/setup/jenkins-gitlab/jenkins_test_project.png index 724e79cd909a..f37c0dd6ff6f 100644 Binary files a/docs/dev/setup/jenkins-gitlab/jenkins_test_project.png and b/docs/dev/setup/jenkins-gitlab/jenkins_test_project.png differ diff --git a/docs/dev/setup/jenkins-gitlab/timestamper_config.png b/docs/dev/setup/jenkins-gitlab/timestamper_config.png index 69a3a39e9da4..7fc88479c419 100644 Binary files a/docs/dev/setup/jenkins-gitlab/timestamper_config.png and b/docs/dev/setup/jenkins-gitlab/timestamper_config.png differ