To connect your Cloud Platform application with Code Studio:

• Configure your working environment by using one of the following steps:
  • Create a new Cloud IDE for the desired application.
  • Open an existing Cloud IDE on the desired application.
  • Open a local environment, and install Acquia CLI.
• Generate a Cloud Platform API token, and make a note of the API key and API secret as you cannot retrieve them after closing your browser tab.

• Generate a Code Studio personal access token:

  • Log in to Code Studio.
  • Make sure the sidebar drawer is open, hover or click the icon on top left corner of the page.
  • Click your profile icon.

  • Click Edit profile.

    The system displays your user settings.

  • Click Access Tokens.
  • In the Add a personal access token section, provide the required details to create a new personal access token for authenticating with Code Studio.
  • In Name, enter a name for the token.
  • In Selected Scopes, select the api and write_repository checkboxes.

  • Click Create personal access token.

    Code Studio creates your new personal access token and displays it on the screen.

  • Copy your new token.

  Important

  You must save your personal access token as you cannot access it again.

• Authenticate with Code Studio:

  • If you are using a Cloud IDE, run:

    copy

    glab auth login --hostname=code.acquia.com                                           

    Select HTTPS when prompted.

  • If you are using a local environment, configure the SSH keys for Acquia Platform.

• Create and/or configure a Code Studio project for your Cloud Platform application with the following commands:

  copy

  acli update
  
  acli cs:wizard --gitlab-host-name=code.acquia.com                                                        

  When you create a project, the system prompts you to select the project type. This prompt appears only if your account has at least one codebase. You may choose to create one of the following:

  
  • A Code Studio project for an application
  • A Code Studio project for a codebase

  Before you run the acli cs:wizard --gitlab-host-name=code.acquia.com command, ensure that the assigned user role in Acquia Cloud has the following permissions:

  a. Pull and deploy code, files, or databases to non-production environments.
  b. Add SSH key to git repository.
  c. Add SSH key to non-production environments.
  d. Add a CD environment.
  e. Delete a CD environment.
  f. Manage environment variables on a non-production environment.

  Refer to the Acquia Cloud documentation for the steps to create, view, assign, edit, or delete role permissions.

• The ACLI command walks you through the following process:

  • (prompt) Creating an API token for Code Studio
  • (automated) Creating an SSH key for Code Studio
  • (automated) Setting GitLab CI/CD variables
  • (automated) Creating a scheduled pipeline for automatic updates
  • (automated) Pushing your Cloud Platform application code to Code Studio

  When the setup wizard prompts for the token key and secret, paste the the API key and API secret that you noted while generating the token.

Connecting your Cloud Platform application with Code Studio