Can't use remote templates on private repo

Zman94 · December 1, 2023, 3:52pm

Hello. I’m trying to create a remote template in my enterprise organization. After creating the template and pushing a tag, I run

❯ cdktf init --template="https://<org and repo path>/archive/refs/tags/<tag>.zip" --local

The result is the following error

Extracting zip file
Error: end of central directory record signature not found
    at /usr/local/lib/node_modules/cdktf-cli/bundle/bin/cmds/handlers.js:110:448419
    at /usr/local/lib/node_modules/cdktf-cli/bundle/bin/cmds/handlers.js:110:456137
    at /usr/local/lib/node_modules/cdktf-cli/bundle/bin/cmds/handlers.js:110:438097
    at FSReqCallback.wrapper [as oncomplete] (node:fs:682:5)

which I believe to be from the inabillity to pull the zip file from the repository.

Can I get some assistance with this? Supporting a workaround for this such as referencing a local path for the template would effectively solve this.

Zman94 · December 1, 2023, 4:02pm

Extra info:
This is the line in cdktf where it makes the request to download the file

github.com

hashicorp/terraform-cdk/blob/main/packages/@cdktf/commons/src/util.ts#L201


      
          export async function downloadFile(
            url: string,
            targetFilename: string
          ): Promise<void> {
            // if the type is inferred to be "http|https" calling .get() is not possible
            // because the options parameter (which we don't use anyway) for get is
            // not compatible between http and https -> so we treat it as http
            const client = (url.startsWith("http://") ? http : https) as typeof http;
            const file = fs.createWriteStream(targetFilename);
            return new Promise((ok, ko) => {
              const request = client.get(url, (response) => {
                if (response.statusCode !== 200) {
                  ko(
                    new HttpError(
                      `Failed to get '${url}' (${response.statusCode})`,
                      response.statusCode
                    )
                  );
                  return;
                }
                response.pipe(file);

Additionally, when I run a wget locally, I get an html file asking me to login with my SSO provider
Lastly, this is where the update would need to be made to support a local file

github.com

hashicorp/terraform-cdk/blob/49558e5435c7858851eb102dddc788f8d4b6e640/packages/cdktf-cli/src/bin/cmds/helper/init.ts#L464


      
              );
            }
          
            return terraformProject;
          }
          
          /**
           *
           * @param templateName either the name of built-in templates or an url pointing to a zip archive
           */
          async function getTemplate(templateName: string): Promise<Template> {
            if (templateName == "") {
              const templateOptionRemote = "<remote zip file>";
              const options = [...templates, templateOptionRemote];
              // Prompt for template
              const selection = await select({
                message: "What template do you want to use?",
                choices: options.map((value) => ({ name: value, value })),
              });
          
              if (selection === templateOptionRemote) {

ansgarm · January 5, 2024, 9:27am

Hi @Zman94

Unfortunately, that is not supported right now.

Linking the issue you created in case anyone else stumbles upon this thread: Can't use remote template on private repo · Issue #3320 · hashicorp/terraform-cdk · GitHub

– Ansgar