Chapter 3. Creating and launching an Ansible development workspace

1. If your administrator provides an example repository for your team, fork the repository to create your own copy.

2. If you do not have access to an example repository, you must create your own repository.

   1. Create a directory for your new repository and use git init to initialize it as a Git repository.
   2. Add a devfile.yaml file to the repository to define the Ansible dev spaces image that you want to use for your Ansible development workspace. See Creating a devfile for Ansible development workspaces.
   3. Add a .code-workspace file to the repository to specify the VS Code extensions for your Ansible development workspace. See Creating a .code-workspace file for Ansible development workspaces.

Procedure

1. In your Git repository for your Ansible development workspace, create a new file named devfile.yaml.

2. Copy and paste the following sample code into the devfile.yaml file:

   ---
   # cspell: disable=devspaces
   schemaVersion: 2.2.2
   metadata:
     name: ansible-devspaces-devfile
   components:
     - name: tooling-container
       container:
         image: registry.redhat.io/ansible-automation-platform-tech-preview/ansible-devspaces-rhel9:latest
         memoryRequest: 256M
         memoryLimit: 6Gi
         cpuRequest: 250m
         cpuLimit: 2000m
         args: ["tail", "-f", "/dev/null"]
         env:
           - name: "ANSIBLE_COLLECTIONS_PATH"
             value: "~/.ansible/collections:/usr/share/ansible/collections"
           - name: KUBEDOCK_ENABLED
             value: "true"
   ...

   Copy to Clipboard Toggle word wrap
3. Modify the image value to the name of your specific Ansible image.
4. Add the devfile.yaml file to your Git repository and push the changes to your source control manager (SCM).

Procedure

1. In your Git repository for your Ansible development workspace, create a new file named .code-workspace.

2. Copy and paste the following sample code into the .code-workspace file:

   {
   	"settings": {
   		"ansible.lightspeed.suggestions.enabled": true,
   		"ansible.lightspeed.enabled": true
   	},
   	"extensions": {
   		"recommendations": [
                           "redhat.ansible",
                           "redhat.vscode-yaml",
                           "redhat.vscode-openshift-connector",
                           "eamodio.gitlens",
   		]
   	},
   }

   Copy to Clipboard Toggle word wrap
3. If you want to add extra extensions to your Ansible development workspace, add them in the extensions.recommendations section of the file.
4. Add the .code-workspace file to your Git repository and push the changes to your source control manager (SCM).

Procedure

1. In a browser, navigate to the OpenShift Dev Spaces dashboard and log in.
2. Select Create Workspace in the navigation pane.
3. In the Import from Git field of the Create Workspace form, enter the URL for the Git repository that contains your devfile.yaml and .code-workspace files.
4. Click Create & Open.

5. OpenShift Dev Spaces displays the progress for the provisioning process of your Ansible development workspace.

   

   View larger image

   

   After the Ansible development workspace launches, a VS Code environment opens in your browser.

6. To open a terminal for executing commands and viewing ansible-lint suggestions in VS Code, click the main menu icon in the Activity bar and select Terminal New Terminal.

   For more information about working in a VS Code terminal, see Getting started with the terminal in the VS Code documentation.