About service accounts

A service account is a special type of account in Google Cloud that enables components and applications of a system to interact with each other and with other APIs. For more information about Google Cloud, see About Google Cloud services.

Apigee hybrid uses Google Cloud service accounts to perform a variety of tasks, including:

  • Send log and metrics data
  • Pull trace requests
  • Connect to API gateway for administrative API requests
  • Execute back ups
  • Download proxy bundles

While one service account could perform all of these operations, for production enviroments Apigee recommends that you create multiple service accounts, each assigned to a specific task and each with its own set of permissions. This enhances security by compartmentalizing access and limiting each service account's scope and access privileges. As with user accounts, these permissions are applied by assigning one or more roles to the service account.

To operate properly, Apigee hybrid requires you to create several service accounts. Each service account requires a specific role or roles that enable it to perform its function.

The following table describes the service accounts for the hybrid components. The names given for each service account are the default names. You can use any names you want, but the names should be easy to identify with each account's purpose.

Component* Role Required for basic install? Description
apigee-cassandra Storage Object Admin
roles/storage.objectAdmin
Allows Cassandra backups to Cloud Storage, as described in Backup and recovery.
apigee-distributed-trace Cloud Trace Agent
roles/cloudtrace.agent
Allows the hybrid runtime plane to participate in distributed request tracing in a format compatible with systems like Google Cloud Trace and Jaeger.
apigee-logger Logs Writer
roles/logging.logWriter
Allows logging data collection, as described in Logging. Only required for non-GKE cluster installations.
apigee-mart Apigee Connect Agent
roles/apigeeconnect.Agent
Allows MART service authentication. The Apigee Connect Agent role allows it to communicate securely with the Apigee Connect process, as described in Using Apigee Connect.
apigee-metrics Monitoring Metric Writer
roles/monitoring.metricWriter
Allows metrics data collection, as described in Metrics collection overview.
apigee-org-admin Apigee Organization Admin
(suggested name)
roles/apigee.admin
Lets you call the getSyncAuthorization API and setSyncAuthorization API. Because Apigee Org Admin is an external role to the Runtime plane, you cannot assign this role to the service account with the create-service-account tool.
apigee-synchronizer Apigee Synchronizer Manager
roles/apigee.synchronizerManager
Allows the synchronizer to download proxy bundles and environment configuration data. Also enables operation of the trace feature.
apigee-udca Apigee Analytics Agent
roles/apigee.analyticsAgent
Allows the transfer of trace, analytics and deployment status data to the management plane.
apigee-watcher Apigee Runtime Agent
roles/apigee.runtimeAgent
Apigee Watcher pulls virtual hosts related changes for an org from synchronizer and makes necessary changes to configure istio ingress.
* This name is used in the downloaded service account key's filename.

As an alternative, for nonproduction, test, and demo environments, you can use a single service account with all the roles assigned to it. This is not recommended for production environments.

Component* Role Required for basic install? Description
apigee-non-prod Apigee Analytics Agent, Apigee Connect Agent, Apigee Organization Admin, Apigee Runtime Agent, Apigee Synchronizer Manager, Cloud Trace Agent, Logs Writer, Monitoring Metric Writer, Storage Object Admin Or all required SAs above Single service account for demo or test environments. See Install, Part 2, Step 5: Create service accounts.

In addition to creating the service accounts listed in this table, you will use each accounts private keys to generate access tokens so that you can access the Apigee APIs. The create-service-account tool automaticallyl downloads the key files into a directory on your local machine when it creates or updates the service accounts.

Create the service accounts

There are several ways to create service accounts, including:

Each of these is described in the following sections.

Use the create-service-account tool

The create-service-account tool is available after you download and expand apigeectl in the tools/ directory. It hybrid component-specific service accounts and assigns the required roles for you. The tool also automatically downloads the service account keys and stores them on your local machine.

For example, the following command will create all the separate individual service accounts for a production environment, assign the appropriate IAM roles to each service account, and download each accounts private key file to the ./service-accounts directory:

./tools/create-service-account --env prod

The following command creates a single service account named apigee-non-prod with all IAM roles for all hybrid components, suitable for demo and test environments, but not for production environments:

./tools/create-service-account --env non-prod

For more information on using create-service-account, see create-service-account reference.

Use the Google Cloud console

You can create service accounts with the Google Cloud console.

To create service accounts with the Google Cloud console:

  1. Open the Google Cloud Console and log in with the user account you created in Step 1: Create a Google Cloud account.
  2. Select the project that you created in Step 2: Create a Google Cloud project.
  3. Select IAM & admin > Service accounts.

    The console displays the Service accounts view. This view displays a list of the project's service accounts. (In most cases, there will be no accounts listed yet, although there might be default service accounts in the list, depending on how you created your project.)

  4. To create a new service account, click +Create Service Account at the top of the view.

    The Service account details view displays.

  5. In the Service account name field, enter the name of the service account.

    Apigee recommends that you use a name that reflects the service account's role; you can set the name of the service account to be the same name as the component that uses it. For example, set the name of the Logs Writer service account apigee-logger.

    For more information about the service accounts names and roles, see Service accounts and roles used by hybrid components.

    As you enter a name, Google Cloud generates a unique service account ID for you, which is structured like an email address, as the following example shows:

    Example Id of apigee-logger@hybrid-42.iam.gserviceaccount.com

    You can optionally add a description in the Service account description field. Descriptions are helpful at reminding you what a particular service account is used for.

  6. Click Create.

    Google Cloud creates a new service account and displays the Service account permissions view, as the following example shows:

    Create service account with no permissions selected

    Use this view to assign a role to your new service account.

  7. Click the Select a role drop-down list.
  8. Select the role for the service account, as described in Service accounts and roles used by hybrid components. If the Apigee roles do not appear in the drop down list, refresh the page.

    For example, for the logging component, select the Logs Writer role.

    If necessary, enter text to filter the list of roles by name. For example, to list only the Apigee roles, enter Apigee in the filter field, as the following example shows:

    Service account permissions list matching Apigee

    You can add more than one role to a service account, but Apigee recommends that you only use one role for each of the recommended service accounts. To change the roles of a service account after you have created it, use the IAM & admin panel in the Google Cloud.

  9. Click Continue.

    Google Cloud displays the Grant users access to this service account view:

    Fields for Service account users role and Service account admins role, button for Create key

  10. Under Create key (optional), click Create Key.

    Google Cloud gives you the option to download a JSON or P12 key:

    Select JSON or P12 key type

  11. Select JSON (the default) and click Create.

    Google Cloud saves the key file in JSON format to your local machine and displays a confirmation when it is successful, as the following example shows:

    Example filename.json

    You will later use some of the service account keys to configure hybrid runtime services. For example, when you configure the hybrid runtime, you will specify the location of the service account keys using the SERVICE_NAME.serviceAccountPath properties.

    These keys are used by the service accounts to get access tokens, which the service account then uses to make requests against the Apigee APIs on your behalf. (But that's not for a while yet; for now, just remember where you saved it.)

  12. Repeat steps 4 through 11 for each service account listed in Service accounts and roles used by hybrid components (except the apigee-mart account—which has no role associated with it—so do not assign it a role).

    When you're finished, you should have the following service accounts (in addition to the defaults, if any):

    List of service accounts. Column 1 selection box, column 2 Email, column 3 Status, column 4 service account name

    In the Google Cloud Console, service accounts are indicated with the left side key, right side half rectangle, all underlined icon.

After you create a service account, if you want to add or remove a role to it, you must use the IAM & Admin view. You cannot manage roles for service accounts in the Service accounts view.

Use the gcloud service account creation APIs

You can create and manage service accounts with the Cloud Identity and Access Management API.

For more information, see Creating and managing service accounts.

Troubleshooting