actions/importer-labs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update gitlab configure lab

Browse Source
This commit is contained in:
Ethan Dennis
2022-09-06 15:39:17 -07:00
parent 7f20cfa938
commit af6faa7006
2 changed files with 61 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
gitlab/1-configure.md
+53 -48
View File
@@ -1,67 +1,72 @@
# Configure Valet to work with GitLab
In this lab, you will use the Valet `configure` command to set up the required information to communicate with the GitLab and GitHub instances. The `configure` command can be used for all of the supported providers, in this lab we will be focusing on GitLab.
# Configure credentials for Valet
- [Prerequisites](#prerequisites)
- [Configuring credentials](#configuring-credentials)
- [Verify your environment](#verify-your-environment)
- [Next Lab](#next-lab)
In this lab, you will use the `configure` CLI command to set the required credentials and information for Valet to use when working with GitLab and GitHub.
## Prerequisites
1. Followed [steps](../gitlab#readme) to set up your codespace environment.
You will need to complete all of the setup instructions [here](./readme.md#configure-your-codespace) prior to performing this lab.
## Configuring credentials
1. Run the setup script in the codespace terminal `source ./gitlab/bootstrap/setup.sh` to ensure the GitLab instance is ready.
2. Login to the GitLab instance to generate a personal access token:
1. Run the setup script in the codespace's terminal to ensure the GitLab server is ready:
```bash
./gitlab/bootstrap/setup.sh
```
2. Open the GitLab server in a new browser tab:
- Click the `PORTS` tab in the codespace terminal window.
- In the `PORTS` tab find the row for port 80.
- Hover over the address under the `Local Address` column, and click the globe to "open in browser".
- Login to the GitLab server with username: `root` and password: `valet-labs!`
- follow the GitLab [instructions](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) to generate a token that has `read_api` scope.
- Record token for a later step.
3. Create a GitHub personal access token (PAT).
- Navigate to your GitHub `Settings` - click your profile photo and then click `Settings`.
- Go to `Developer Settings`
- Go to `Personal Access Tokens` -> `Legacy tokens (if present)`
- Click `Generate new token` -> `Legacy tokens (if present)`. If required, provide your password.
- Select at least these scopes: `read packages` and `workflow`. Optionally, provide a text in the **Note** field and change the expiration.
- Click `Generate token`
- Copy the token somewhere safe and temporary.
4. Run Valet configure commands
- In the codespace terminal window click back to the `TERMINAL` tab.
- Run `gh valet configure`
- Use the down arrow key to highlight `GitLab CI`, press the spacebar to select, then hit enter to accept.
- At the prompt enter your GitHub Username and press enter.
- At the GitHub Container Registry prompt enter the GitHub PAT generated in step 3 and press enter
- At the GitHub PAT prompt enter the GitHub PAT generated in step 3 and press enter.
- At the GitHub url prompt enter the GitHub instance url or hit enter to accept the default, if you are using github.com then the default is the right choice.
- At the GitLab CI token prompt enter the GitLab CI access token from step 2 and press enter.
- At the GitLab CI url prompt enter `http://localhost` and press enter.
- At the Personal access token to fetch source code in GitHub prompt, if any of your Jenkins pipelines have source code in a GitHub repository enter the GitHub PAT that would have acess to these files.
5. If all went well you should see a similar output in your terminal and a new file (.env.local) should have been created in the root of the project.
- Hover over the address under the `Local Address` column and click the globe to "open in browser".
![configure-result](https://user-images.githubusercontent.com/18723510/183990474-d0b2559c-d2bf-40d9-ac43-19af53e45329.png)
3. Create a GitLab personal access token:
- Authenticate with the GitLab server using the following credentials:
- Username: `root`
- Password: `valet-labs!`
- Follow the GitLab [instructions](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) to generate a personal access token.
- Ensure the token has the `read_api` scope.
- Copy the generated token and save in a safe location.
4. Create a GitHub Personal Access Token (PAT):
- Open github.com in a new browser tab.
- Click your profile photo in the top right of the UI and click `Settings`.
- Click on `Developer Settings` in the left hand panel.
- Click `Personal Access Tokens` and then `Legacy tokens` (if present).
- Click `Generate new token` and then `Legacy tokens`. You may be required to authenticate with GitHub during this step.
- Select the following scopes: `read:packages` and `workflow`.
- Click `Generate token`.
- Copy the generated PAT and save in a safe location.
4. Run the `configure` CLI command:
- Select the `TERMINAL` tab from within the codespace terminal window.
- Run the following command: `gh valet configure`.
- Using the down arrow key to highlight `GitLab CI`, press the spacebar to select, and then hit enter to continue.
- At the prompt enter your GitHub Username and press enter.
- At the GitHub Container Registry prompt enter the GitHub PAT generated in step 4 and press enter.
- At the GitHub PAT prompt enter the GitHub PAT generated in step 4 and press enter.
- At the GitHub url prompt enter the GitHub instance url or hit enter to accept the default value (`https://github.com`).
- At the GitLab CI token prompt enter the GitLab CI access token from step 3 and press enter.
- At the GitLab CI url prompt enter `http://localhost` and press enter.
![img](https://user-images.githubusercontent.com/18723510/183990474-d0b2559c-d2bf-40d9-ac43-19af53e45329.png)
## Verify your environment
To verify our environment is configured correctly, we are going to run a `update` and `dry-run` command. The `update` command will download the latest version of Valet to your codespace. We will go further into details about the `dry-run` command in a later lab, but for now we will just verify it finishes with no errors.
1. In the codespace terminal update Valet by running `gh valet update`
2. In the terminal you should see a confirmation that it logged into the GitHub Container Registry and pulled the latest version.
To verify our environment is configured correctly, we are going to run the `update` CLI command. The `update` CLI command will download the latest version of Valet to your codespace.
1. In the codespace terminal run the following command:
```bash
gh valet update
```
2. You should see a confirmation that you were logged into the GitHub Container Registry and Valet was updated to the latest version.
```bash
Login Succeeded
latest: Pulling from valet-customers/valet-cli
Digest: sha256:a7d00dee8a37e25da59daeed44b1543f476b00fa2c41c47f48deeaf34a215bbb
Status: Image is up to date for ghcr.io/valet-customers/valet-cli:latest
ghcr.io/valet-customers/valet-cli:latest
```
3. Run the dry-run command in the codespaces terminal to verify Valet can communicate with the GitLab server
```
gh valet dry-run gitlab --output-dir ./tmp/dry-run-lab --namespace valet --project basic-pipeline-example
```
4. In the terminal you should see the command was successful, if not it is a good time to practice the configure command again and make sure the access tokens values are correct and were generated with the correct permissions.
![configure-dry-run](https://user-images.githubusercontent.com/18723510/183989794-d51fa29d-b4c0-4074-8402-a55ffcea3a6b.png)
### Next Lab
[Perform and a audit of GitLab](../gitlab/2-audit.md)
### Next lab
[Perform an audit of a GitLab server](./2-audit.md)
jenkins/1-configure.md
+2 -5
View File
@@ -4,10 +4,6 @@ In this lab, you will use the `configure` CLI command to set the required creden
You will need to complete all of the setup instructions [here](./readme.md#configure-your-codespace) prior to performing this lab.
- [Configuring credentials](#configuring-credentials)
- [Verify your environment](#verify-your-environment)
- [Next Lab](#next-lab)
## Configuring credentials
1. Open the Jenkins server in a new browser tab:
@@ -43,6 +39,7 @@ You will need to complete all of the setup instructions [here](./readme.md#confi
- At the Jenkins token prompt enter the Jenkins access token from step 2 and press enter.
- At the Jenkins url prompt enter `http://localhost:8080/` and press enter.
- At the Personal access token to fetch source code in GitHub prompt hit enter to accept the default value.
![img](https://user-images.githubusercontent.com/19557880/184041328-ce54ea22-b0cd-4c84-b02c-10ad7b09ad89.png)
## Verify your environment
@@ -65,6 +62,6 @@ To verify our environment is configured correctly, we are going to run the `upda
ghcr.io/valet-customers/valet-cli:latest
```
### Next Lab
### Next lab
[Perform an audit of a Jenkins server](2-audit.md#perform-an-audit-of-a-jenkins-server)