Skip to main content

Multi-tenant private recipes

warning

The instructions on this page will only apply to you if:

  • Your company is using the app.moderne.io tenant AND
  • You want to upload and deploy your own company-specific recipes that nobody else can, but your team should be able to see or run

If your company has your own private tenant (e.g., <tenant>.moderne.io), then this page does not apply to you.

Configuration​

When you log in to Moderne, you can either log in with GitHub or BitBucket Cloud.

In order for this feature to work, everyone at your company who logs in to Moderne will need to use the same SCM to log in, and they must have the same email domain for their primary email address in said SCM.

In other words, if you worked at Foo and you used GitHub to log in to app.moderne.io, everyone at your company would need to have their primary GitHub email address be set to their Foo email address (e.g., <someone>@foo.io).

Once that's true, you will need to grab the email domain (foo.io) and:

Set the MODERNE_AGENT_TENANTDOMAIN property in your agent configuration to the domain name from above.

Deploying private recipes​

Anyone with an email address that matches the tenantDomain is allowed to both upload and use recipes for that domain.

danger

All recipes that should be private to your company must start with the reverse of your email domain name (e.g., if your domain is foo.io, then all recipes must start with io.foo).

  1. Navigate to the Moderne deploy page and press the Add button:

  1. Fill in the recipe artifact information and press "deploy recipe artifact".

tip

You can use LATEST as the version so that the recipe will pick up the latest snapshot or release version.\

Using private recipes​

Anyone logged in with the correct email domain will automatically see their company's private recipes in the marketplace. They can use them just like any other (public) recipe.

Troubleshooting​

You cannot upload a tenant private recipe with a groupId that does not start with the reverse domain name.

This warning will appear when your recipe does not start with the reverse of your email domain. For example, if your email domain was foo.io and you tried to upload a recipe that was bar.io.

Unable to deploy as a private recipe, io.foo is not a known tenant domain.

This warning will appear if you try to upload a private recipe and your email domain is not a known/configured tenant domain.