Credentials configuration file

A credentials configuration file for Google Distributed Cloud software only for VMware stores usernames and passwords separately from your cluster configuration files, which helps limit the number of people who have access to the credentials. Your cluster configuration files, such as an admin cluster configuration file, reference entries in this file to authenticate with systems such as your vCenter server or a private Docker registry.

Template

Filling in the fields in a credentials configuration file

In your credentials configuration file, enter field values as described in this section.

items

Array of objects, each of which holds a username and password.

items[0].name

String. A name of your choice for the object. For example:

items:
- name: "vcenter-creds"

items[0].username

String. A username. For example:

items:
- name: "vcenter-creds"
  username: "my-vcenter-account"

When you are using Active Directory (AD), you must specify the username with the domain name in the username field, for example: username: "userName@domainName" or username: "domainName\\username". If you don't specify the domain name, the vSphere Container Storage Plug-in won't function properly.

items[0].password

String. A password. For example:

items:
- name: "vcenter-creds"
  password: "U$icUKEW#INE"

Example of a credentials configuration file

Here's an example of a credentials configuration file that holds three sets of credentials.

apiVersion: v1
kind: "CredentialFile"
items:
- name: "vcenter-creds"
  username: "my-vcenter-account"
  password: "U$icUKEW#INE"
- name: "f5-creds"
  username: "my-f5-account"
  password: "exvQVx^@L%F1"
- name: "private-registry-creds"
  username: "my-registry-account"
  password: "kIJGS&uRm2Vh"

Notice that each block of credentials has a name. In your admin cluster configuration file, you specify the name of a credentials block in a fileRef.entry field.

Here's an example that shows portions of an admin cluster configuration file. You can see that the file specifies three blocks of credentials, all of which are in the same credentials file:

vCenter:
  credentials:
    fileRef:
      path: "my-folder/my-creds.yaml"
      entry: "vcenter-creds"
...
loadBalancer:
  f5BigIP:
    credentials:
      fileRef:
        path: "my-folder/my-creds.yaml"
        entry: "f5-creds"
...
privateRegistry:
  credentials:
    fileRef:
      path: "my-folder/my-creds.yaml"
      entry: "private-registry-creds"