Build fails in the source step

For public repositories

If the failure happened for a public repository, then update the existing build to use the HTTPS URL of the Git repository, and run the build.

1. Use the ibmcloud ce build update command to update the build configuration to use the HTTPS URL of the Git repository; for example,

   ibmcloud ce build update --name <BUILD_NAME> --source <GIT_REPO> 
   

2. Use the ibmcloud ce buildrun submit command to submit a new build run. For the buildrun submit command, you must specify the --build option to provide the name of your build configuration. You can optionally specify the --name option to provide the name for this build run. If you specify the --name option, make sure that you use a different build run name from the failed build run, or ensure that you delete the failed build run by using the ibmcloud ce buildrun delete command. For example,

   ibmcloud ce buildrun submit --build <BUILD_NAME> --name <BUILDRUN_NAME>
   

For private repositories

If the failure happened for a private repository, then create a an SSH secret and use the SSH protocol. An SSH secret contains the credentials to access the private repository that contains the source code to build your container image. An SSH secret is also used as a Git repository access secret. The SSH secret contains a private key while the corresponding public key is stored with your Git repository provider. For more information about creating a key pair and store the public part in GitHub or GitLab, see Accessing private code repositories. It is important that your private key file is not encrypted with a passphrase before you can upload it to Code Engine. The format of the private key file can vary, which makes it complicated to assess if the file is encrypted. Depending on the version of the ssh-keygen tool that was used to create the key pair, the file might have one of the following headers:

• If the file starts with -----BEGIN RSA PRIVATE KEY-----, then it uses the PEM format and was created with an older version of ssh-keygen. If the file is encrypted with a passphrase, then it typically contains a line like this: Proc-Type: 4,ENCRYPTED.

• If the file starts with -----BEGIN OPENSSH PRIVATE KEY-----, then it was created with a newer version of ssh-keygen. To verify whether it is encrypted with a passphrase, run the ssh-keygen -p -f <ID_FILE> command.

  ssh-keygen -p -f <ID_FILE>   
      Enter old passphrase:
  

  ssh-keygen -p -f <ID_FILE>
      Key has comment '<COMMENT>'
  Enter new passphrase (empty for no passphrase): 
  

  You can escape the command by using Ctrl+C. If the command requires the old passphrase (first example), then the original file was encrypted, otherwise it directly asks for the passphrase of the new file (second example).

  To decrypt an encrypted private key file, run the following command and leave the new passphrase empty.

  $ ssh-keygen -p -f <ID_FILE>
  
  Enter old passphrase: <PASSPHRASE>
  Key has comment '<COMMENT>'
  Enter new passphrase (empty for no passphrase):
  Enter same passphrase again:
  Your identification has been saved with the new passphrase.
  

  This command modifies the private key file. If you need to retain your encrypted version, create a copy first.

To create an SSH secret and use the SSH protocol,

1. Run the ibmcloud ce secret create --format ssh command. An SSH secret is also used as a Git repository access secret. The SSH_KEY_PATH needs to point to the private key file that matches the public key in your account or the deployment key in the repository. This command requires a name and a key path, and also allows other optional arguments such as the path to the known hosts file. If you specify the --known-hosts-path option, include the host of your Git repository, for example github.com or gitlab.com in your known hosts file. For more information, see Accessing private code repositories.

   ibmcloud ce secret create --format ssh --name <GIT_REPO_SECRET> --key-path <SSH_KEY_PATH> --known-hosts-path  <PATH_TO_KNOWN_HOSTS_FILE> 
   

2. Use the ibmcloud ce build update command to update the build configuration to use the SSH URL of the Git repository and reference the SSH secret, <GIT_REPO_SECRET>. For example,

   ibmcloud ce build update --name <BUILD_NAME> --source <GIT_REPO> --git-repo-secret <GIT_REPO_SECRET>
   

   In the prior example, specify the SSH URL by using the git@ prefix for your source, such as --source git@github.com:IBM/CodeEngine.git.