Manage plugins

This page describes how you can view, edit, and delete plugins created using Service Extensions.

For a product overview, see Service Extensions overview.

View plugins

This section describes how you can view plugins and plugin versions created using Service Extensions.

List plugins

To list the plugins in your project, follow these steps:

Console

  1. In the Google Cloud console, go to the Service Extensions page.

    Go to Service Extensions

  2. Click the Plugins tab.

    A list of the plugins appears in a sortable table with the following information:

    • Status: The status of the plugin. If a service isn't attached, the value is Not attached. If a service is attached with a plugin, the value is Attached.
    • Name: The name of the plugin.
    • Main version: The active version of the plugin.
    • Product: The Google Cloud product to which the plugin is attached.
    • Type: The type of extension.
    • In use by: One or more extensions to which the plugin is associated.
    • Last modified: The time when the plugin was last modified.
    • Labels: The labels added to the plugin.

  3. Optional: To filter the list, do the following:

    1. Click next to Filter table to see a list of properties.

    2. From the list, select a property.

      The property name, followed by a colon, appears next to the Filter table label.

    3. Insert a space next to the colon to see a list of values that match the property, and then select a value from the list.

    4. Optional: Enter the OR operator between property-value pairs to specify combined filters.

  4. Optional: To perform other operations with a selected plugin, click More actions, and then select an option:

gcloud

Run the gcloud beta service-extensions wasm-plugins list command:

gcloud beta service-extensions wasm-plugins list

The plugins in your project are listed in a table that has the following information:

  • Name: the name of the plugin
  • Description: the description of the plugin
  • Main version: the active version of the plugin
  • Update time: the time when the plugin was last modified

View the details of a plugin

To view the details of a plugin, use one of the following methods:

Console

  1. In the Google Cloud console, go to the Service Extensions page.

    Go to Service Extensions

  2. Click the name of the plugin for which you want to see details.

    The Details page for the plugin opens. It has the following sections:

    • Basic information: This section shows these basic details about the plugin: the product, the load balancer type, the extension type, the extensions that are using the plugin, creation and modification timestamps for the plugin, size of the plugin, labels, and, if logging is enabled, the log sample rate and the minimum logging level.

    • Versions: This section shows these details about plugin versions: the version of plugin, the creation timestamp, a description if one was entered, the URI and digests for the container image, and the plugin configuration file or image and related digests.

      You can click the image URL to view its details.

gcloud

  • To view the details of a plugin, run the gcloud beta service-extensions wasm-plugins describe command:

    gcloud beta service-extensions wasm-plugins describe WASM_PLUGIN

    Replace WASM_PLUGIN with the name of the plugin.

    The following details about the plugin are shown:

    • the plugin name
    • the creation and modification timestamps for the plugin
    • the labels
    • the log sampling rate (if logging is enabled)

  • To list the versions for a plugin, use the gcloud beta service-extensions wasm-plugin-versions list command:

    gcloud beta service-extensions wasm-plugin-versions list WASM_PLUGIN

    Replace WASM_PLUGIN with the name of the plugin.

    The versions of the specified plugin are listed in a table with the name of the plugin.

  • To view the details of a plugin version, use the gcloud beta service-extensions wasm-plugin-versions describe command:

    gcloud beta service-extensions wasm-plugin-versions describe WASM_PLUGIN_VERSION

    Replace WASM_PLUGIN_VERSION with the main version of the plugin.

    The following details about the plugin version are shown:

    • the version name
    • the creation timestamp
    • a description, if it was entered
    • the URI and digests for the container image
    • the plugin configuration file or image and related digests

Edit plugins

This section describes how you can edit plugins created using Service Extensions.

Edit a plugin

To edit a plugin, follow these steps:

Console

  1. In the Google Cloud console, go to the Service Extensions page.

    Go to Service Extensions

  2. Click the Plugins tab.

  3. For the plugin that you want to edit, click More actions, and then select Edit.

    Alternatively, click the plugin name, and then, on the Details page, click the Edit button.

    On the Edit plugin page, the name of the plugin isn't editable. You can edit other details.

  4. Make changes as required.

    For information about most fields, see Create a plugin.

    For information about the Versions section, see Add a new version of a plugin.

  5. Click Update plugin.

gcloud

Run the gcloud beta service-extensions wasm-plugins update command:

gcloud beta service-extensions wasm-plugins update WASM_PLUGIN \
    --description=PLUGIN_DESCRIPTION \
    --labels=[LABELS,...]

Replace the following:

  • WASM_PLUGIN: the name of the plugin
  • PLUGIN_DESCRIPTION: the description of the plugin
  • LABELS: labels in the form of key-value pairs separated by commas

Add a new version of a plugin

You can create a new version of the plugin code and then add it as a new version of the plugin.

To add a new version of a plugin, follow these steps:

Console

  1. On the Edit plugin page, in the Versions section, click Add version.

  2. On the Add version pane, specify the details for the plugin version.

  3. Optional: Select the Set as main checkbox.

    Alternatively, set this version as the main version later.

  4. Click Add.

  5. Click Update plugin.

gcloud

Run the gcloud beta service-extensions wasm-plugins update command:

gcloud beta service-extensions wasm-plugins update WASM_PLUGIN \
    --image=IMAGE \
    --main-version=MAIN_VERSION \
    --plugin-config=PLUGIN_CONFIG | --plugin-config-file=PLUGIN_CONFIG_FILE | --plugin-config-uri=PLUGIN_CONFIG_URI

Replace the following:

  • WASM_PLUGIN: the ID or the fully qualified name of the plugin
  • IMAGE: the URI of the container image that has a new version of the Wasm module stored in the Artifact Registry repository.
  • MAIN_VERSION: the ID of the plugin version to create and set as the main (or serving) version.
  • PLUGIN_CONFIG, PLUGIN_CONFIG_FILE, or PLUGIN_CONFIG_URI: the optional configuration file, which can be specified inline as text, as a local file, or as a container image in Artifact Registry, respectively.

Change the main version of a plugin

To change the main version of a plugin, follow these steps:

Console

  1. On the Edit plugin page, in the Versions section, select a version that's inactive, and then click Set as main.

    Alternatively, while creating a new version of the plugin, you can opt to set the version as the main version.

  2. Click Update plugin.

gcloud

Run the gcloud beta service-extensions wasm-plugins update command:

gcloud beta service-extensions wasm-plugin update \
    --main-version=WASM_PLUGIN_VERSION

Replace WASM_PLUGIN_VERSION with the name of the main version of the plugin.

It might take a few minutes for the new plugin version to be distributed across all locations. The number of minutes might vary across locations because the plugin isn't delivered to all locations simultaneously.

Delete plugins

This section describes how you can delete plugins and plugin versions created using Service Extensions.

Delete a plugin

To delete a plugin, follow these steps:

Console

  1. Go to the Service Extensions page.

    Go to Service Extensions

  2. Click the Plugins tab.

  3. For the plugin that you want to delete, click the More actions button, and then select Delete.

    Alternatively, click the plugin name, and then click the Delete button on the Details page.

    Plugins that are in use by an extension can't be deleted. To delete such a plugin, first modify the extension to remove the plugin or delete the extension.

  4. In the confirmation message box, confirm the operation by clicking Delete.

gcloud

  1. Remove the references to the plugin from the service configuration, and then reimport the configuration YAML file.

    For more information, see how to configure Cloud Load Balancing route and traffic plugins and Media CDN plugins.

  2. Run the gcloud beta service-extensions wasm-plugins delete command:

    gcloud beta service-extensions wasm-plugins delete WASM_PLUGIN

    Replace WASM_PLUGIN with the name of the plugin.

Deleting a plugin also deletes the related plugin resources.

Delete a version of a plugin

To delete a version of a plugin, follow these steps:

Console

  1. In the Google Cloud console, go to the Service Extensions page.

    Go to Service Extensions

  2. Click the Plugins tab.

  3. Select the plugin that you want to edit and switch to the edit mode.

  4. In the Versions section, select checkboxes for the versions that you want to delete, and then click Delete.

  5. Click Update plugin.

gcloud

Run the gcloud beta service-extensions wasm-plugin-versions delete command:

gcloud beta service-extensions wasm-plugin-versions delete WASM_PLUGIN_VERSION

Replace WASM_PLUGIN_VERSION with the name of a plugin version that's not being used as the main version.

If a version is set as the main version, which is the main (active) version, you can delete it only after you set another version as the main version.

What's next