Deploy FaaS Using a Private GitHub Repository

Configure Integrations for Authentication

Configure Integrations for Authentication Get the required project and set up integrations for username and password. To locate the username, refer to your GitHub URL:

Copy

Copied

https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.git

For the password, an access token is required to serve as authentication credentials. Detailed instructions on generating a fine-grained personal access token can be found here.

To grant read-only access to your repository, assign read only permissions to the repository “Contents”. alt text

Copy

Copied

project = dl.projects.get(project_id="project_id")
username_int = project.integrations.create(
    integrations_type=dl.IntegrationType.KEY_VALUE,
    name="username",
    options={"key": "username", "value": "github_username"},
)

password_int = project.integrations.create(
    integrations_type=dl.IntegrationType.KEY_VALUE,
    name="password",
    options={"key": "password", "value": "github_password"},
)

Define the Package Module of Your FaaS

Define the required package module. This module serves as a description and structure of your codebase.

Copy

Copied

module = [
    dl.PackageModule(
        class_name="ServiceRunner",
        entry_point="main.py",
        functions=[
            dl.PackageFunction(
                function_name="run",
                inputs=[dl.FunctionIO(name="item", type=dl.PackageInputType.ITEM)],
                outputs=[dl.FunctionIO(name="item", type=dl.PackageInputType.ITEM)],
            )
        ],
    )
]

Push the Package with Credentials

Now, package your module and credentials together and push them to your project. This ensures secure access to your private GitHub repository.

Copy

Copied

package = project.packages.push(
    package_name="privategit",
    modules=module,
    codebase=dl.GitCodebase(
        git_url="git_url",
        git_tag="main",
        credentials={
            "username": {"key": "username", "id": username_int.id},
            "password": {"key": "password", "id": password_int.id},
        },
    ),
)

Deploy the FaaS service

Finally, deploy your FaaS service using the package and module you've created.

Copy

Copied

service = project.services.deploy(
    service_name="privategit", package=package, module_name=module[0].name
)