Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction

Create Kubectl plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Kubectl plugin configuration parameters

Table 1. EC-Kubectl plugin configuration parameters
Parameter Description

Configuration

Required. The unique name for the plugin configuration.

Description

A description for the plugin configuration.

Kubectl path

Required. The absolute path to kubectl. For example, /var/kubectl.

Kubeconfig source

Required. The source of the kubeconfig content required by kubectl.

  • If the content comes from a file that kubectl uses by default (per Google documentation), choose kubeconfigDefault.

  • If the content comes from text that you specified in the Kubeconfig content field, choose kubeconfigContent.

  • If the content comes from a specific file that you specified in the Kubeconfig path field, choose kubeconfigPath.

Kubeconfig path

The absolute path to kubeconfig file. For example, /var/kconfig.config.

This is only used if the Kubeconfig source is kubeconfigPath. Otherwise this field should be left empty.

Kubeconfig content

In the text field, type any string to identify the content. For example, mylabel. In the content text area, type the content used by kubectl.

This is only used if the Kubeconfig source is kubeconfigContent. Otherwise this field should be left empty.

Kubeconfig context

The context used by kubectl to run against the cluster.

Kubeconfig cluster

The name of the Kubernetes cluster against which kubectl should run.

Kubeconfig user

The name of the kubeconfig user.

Additional options for kubectl

Additional options for kubectl, separated by newlines. For example, --namespace=your-custom-namespace or --log-dir=/var/log/customdir. Additional options can also be provided at the configuration-level. However, no redundancy check is performed if an option is defined in both places.

Log level

The log level to use for logging output. Supported values are DEBUG, INFO, WARN, and ERROR.
Introduction
Create Kubectl plugin procedures