Community Conundrums are live! Learn more

Getting Started with the Dataiku DSS Plugin Store

Getting Started with the Dataiku DSS Plugin Store

What is the Plugin Store, and how do I access it?

A plugin is a package of reusable components that extends the functionality of Dataiku DSS. When you develop a plugin, you are extending the native capabilities of DSS. A plugin contains one or more components. A component is a GUI wrapper around custom code that exposes a Dataiku element such as a Recipe, Dataset, or Web App.

The Dataiku DSS Plugin Store is a repository of extensions created by or for DSS. The main actions you can take in the Plugin Store are: browse, search, find by tag, find by support coverage, and view plugin details. If your user profile belongs to the administrator’s group, you can install and update plugins from the Plugin Store.

Plugins vary from the very simple to the very complex. For example, you can retrieve Wikipedia page views, connect with Salesforce data, or get weather forecast by location. You can find all public plugins in the plugin store. If you are a developer, you can create your own plugins. The possibilities are limitless!

To browse the Plugin Store, first launch Dataiku DSS. Then choose Plugins from the Apps menu appsmenu.png

Search for a plugin

To find a plugin, start typing your search criteria in the search box. Dataiku DSS searches the title and the description of the plugin and displays results as you type. For example, if you start typing the first three letters of Kubernetes, Dataiku DSS displays all results that contain kub.

1a_search.png

Plugin Store search

See a plugin’s details

You can use the Plugin Store to determine where a plugin originated. Click See Details to find out a plugin’s details including the author, version, license, tags, and components.

1a_dss61_pluginstore_seedetails.png

Plugin details

Install a plugin

To install the plugin from the Plugin Store, you must have permission to install plugins, and your Dataiku DSS instance must have HTTPS connectivity to the internet. If you do not have access to the internet, you can install existing plugins from the store by uploading a Zip file, or from a Git repository.

You can install plugins from the Plugin Store if your user profile belongs to the administrator’s group. For more information about security settings, visit Main Permissions.

 

To install a plugin:

1. Search for the plugin you want to install and click Install.

1ainstall_googledrive_plugin.png

2. Confirm that you want to install the plugin.

1aconfirminstall.png

3. If the plugin requires a dedicated code environment, accept the default option, Managed by DSS (recommended). If you want to manage the code environment manually, select Managed manually. Optionally, you can also select to use Conda or a specific Python environment.

4. Click Build New Environment. DSS displays Environment creation.

5. Wait while DSS creates the environment and displays Creation result then click OK

6. Click Next to accept the code environment. Alternatively, If you want to change the code environment, click Change. Once completed, DSS displays a success message.

1aplugin_aftercreationresult_creatingcodeenv.png

The plugin is now available to use. Click Go to Plugin Page to view the installed plugin.

Use a plugin

How do I use the plugin after installing it?

Once installed, the plugin is now available to the DSS instance where you installed it. It is available to all users of the instance. Only administrators can update plugins. 

Visit Plugins > Installed to view the newly installed plugin:

1a_newlyinstalledplugin.png

Newly installed plugin

To use the plugin, open a project on the DSS instance where you installed the plugin, then go to the Flow. A plugin can have more than one component. The type of component determines where the plugin displays. For example, if the plugin contains a Recipe component, you will find the plugin under Plugin recipes. 

Recipe plugins display in Plugin recipes:

1a_plugin_recipes.png

Plugin recipes

Likewise, if the plugin contains a Dataset component, you will find the plugin in the connectors menu:

1a_datasetplugins.png

Dataset plugins

Finally, if the plugin contains a Web App component, you will find the plugin in the Actions menu when viewing a dataset in the Flow:

1awebapp_plugins.png

Web app plugins

Manage your plugins

If you have administrator privileges on your instance of DSS, you can manage your installed plugins by visiting the Summary, Settings, and Usages tabs.

1ainstalledplugins.png

Installed plugins

For example, you can use the Summary tab to find out more information about an installed plugin, including which components it contains and whether or not it requires a dedicated code environment. In the Settings tab, you can manage a plugin’s pre-set parameters. In the Usages tab, you can find out all projects that use the plugin. This information is useful when you are deciding whether or not to update or remove a plugin.

Update a plugin

Plugin authors update their plugins periodically. Check the Plugin Store to find out if there is an available update for your installed plugins. Click Update to install the update.

1a_update_a_plugin.png

Remove or uninstall a plugin

Dataiku does not recommend removing a plugin. If you must remove a plugin, do the following: 

  1. Check the Usages tab to see if any projects are using the plugin. 
  2. If the plugin is not being used, delete the DATA_DIR/plugins/installed/name-of-plugin directory.

1a_plugin_usages_tab.png

Plugin Usages tab

Get support

Dataiku Support covers some plugins. Plugins are not supported by default. Plugins covered by Dataiku Support or tier 2 support are explicitly indicated in the Plugin Store. Visit the Reference Documentation to find out more about support tiers.

1a_plugin_support_coverage.png

Plugin Store Support Coverage

Edit a plugin

You can convert a plugin from the Plugin Store to a Dev Plugin. Use caution. You will not be able to get updates from the store or from your own repositories afterward.

1aconverttodevplugin.png

Convert a plugin to a dev plugin

Find the code for a plugin

You can find the code for some but not all of the public plugins on GitHub.

1a_plugins_github_public.png

DSS public plugins on GitHub

What’s next?

You can find out more information about plugins and even get started making your own plugins. Here is some information to get you started:

 

Labels (2)
Version history
Revision #:
17 of 17
Last update:
‎01-09-2020 10:45 PM
Updated by:
 
Contributors