Skip to main content

Preview

You can access your deployed project as well as its deployed application dependencies through preview URLs which will be created by Flinkwerk automatically.

By default, Flinkwerk auto-generates project URLs as per the following schema:

https://[app]--[branch|tag]--[project].[cluster].[owner].flinkwerk.dev

This is a break-down of the URL elements:

  • [app]: The name of an application which you defined as a dependency in dependencies.[name], e.g. mariadb as in:

    dependencies:
      mariadb:
        type: helm
        sku: bitnami/mariadb
        repository: https://charts.bitnami.com/bitnami

  • [branch|tag]: The name of a Git branch (e.g. my-branch or 42-new-feature) or tag (e.g. my-tag) sanitized to make them URL-safe (e.g. v2-1-0).

  • [project]: The project name, e.g. my-project.

  • [cluster]: A global cluster resource name defined in global.[name], e.g. my-cluster.

  • [owner]: The login name of the user who is the project owner, e.g. my-org.

  • flinkwerk.dev: Default preview URL domain which can be customized in your project configuration (see custom domains).

As per above example values, a project URL could look like this:

https://mariadb--42-new-feature--my-project.my-cluster.my-org.flinkwerk.dev

At the different endpoints of above URL schema, you will be able to access different applications as described below.

Access your project application​

The application you are developing in your project can be viewed at different URLs, depending on whether you use Git or not.

If you deployed your project through Flinkwerk CLI, not using Git, the URL would be composed using the branch name of the Git repository (main in this example):

https://main--[project].[cluster].[owner].flinkwerk.dev

If you use Git for your project and mapped your branches to Flinkwerk environments, then your project's application would be running at:

https://[branch|tag]--[project].[cluster].[owner].flinkwerk.dev
note

Remember that Flinkwerk does not, by itself, perform any branch-related operations in a Git repository. Branch operations are the sole prerogative of the developer, and Flinkwerk merely uses the branch name to compose the corresponding preview URLs.

Access your application dependencies​

You can access an application dependency which you defined in dependencies at this URL:

https://[app]--[branch|tag]--[project].[cluster].[owner].flinkwerk.dev

If you don't use Git and did not map branches to environments, the same applies as outlined in regard to your project application: The default branch would be labeled main.

https://[app]--main--[project].[cluster].[owner].flinkwerk.dev

Configure custom domains​

It is possible to define custom domains for the auto-generated preview URLs as well as for your project application and its application dependencies. See the documentation on custom domains for further details.