Accéder aux métadonnées d'une instance

Google Cloud Platform fournit un serveur de métadonnées qui connaît des informations détaillées sur votre instance App Engine, telles que son identifiant de projet contenant, les comptes de service et les jetons utilisés par les comptes de service. Vous pouvez accéder à ces données à l'aide de simples requêtes HTTP : aucune bibliothèque cliente n'est requise.

Cette page explique comment accéder aux métadonnées d'instance de votre application d'exécution Java 8 déployée en effectuant des appels HTTP aux points de terminaison du serveur de métadonnées approprié.

Remarque : L'accès aux métadonnées est actuellement en lecture seule. Vous ne pouvez pas écrire vos propres métadonnées pour une instance.

Vous pouvez, par exemple, obtenir le jeton du compte de service et le fournir en tant que jeton de support dans l'en-tête Authorization de l'une des API Google Cloud, afin d'authentifier votre application auprès de ce service API particulier. Il s'agit là de l'une des nombreuses applications utiles de cette API. Consultez la documentation de l'API Google Cloud Translation pour obtenir un exemple d'utilisation de ces jetons de support.

Identifier le point de terminaison des métadonnées à utiliser

Le tableau suivant répertorie les points de terminaison où vous pouvez effectuer des demandes HTTP pour des métadonnées spécifiques. Le serveur de métadonnées est accessible à l'adresse http://metadata.google.internal.

Point de terminaison des métadonnées	Description
/computeMetadata/v1/project/numeric-project-id	Numéro de projet attribué à votre projet.
/computeMetadata/v1/project/project-id	ID de projet attribué à votre projet.
/computeMetadata/v1/instance/zone	Zone dans laquelle l'instance est en cours d'exécution.
/computeMetadata/v1/instance/service-accounts/default/aliases
/computeMetadata/v1/instance/service-accounts/default/email	Adresse e-mail du compte de service par défaut attribué à votre projet.
/computeMetadata/v1/instance/service-accounts/default/	Répertorie tous les comptes de service par défaut pour votre projet.
/computeMetadata/v1/instance/service-accounts/default/scopes	Répertorie tous les champs d'application disponibles pour les comptes de service par défaut.
/computeMetadata/v1/instance/service-accounts/default/token	Renvoie le jeton d'authentification pouvant servir à authentifier votre application auprès d'autres API Google Cloud.

Par exemple, pour récupérer votre ID de projet, envoyez une requête à http://metadata.google.internal/computeMetadata/v1/project/project-id.

Effectuer des demandes de métadonnées

Important : L'accès au serveur de métadonnées doit utiliser des sockets natifs, tels que ceux fournis par java.net.HttpURLConnection ou l'objet natif url-stream-handler. Le serveur de métadonnées ne prend pas en charge le service urlfetch.

L'exemple de code suivant récupère et affiche toutes les métadonnées disponibles pour l'instance, à l'exception du jeton du compte de service.

@SuppressWarnings("serial")
// With @WebServlet annotation the webapp/WEB-INF/web.xml is no longer required.
@WebServlet(name = "Metadata", description = "Metadata: Write info about GAE Standard",
    urlPatterns = "/metadata")
public class MetadataServlet extends HttpServlet {

  private final String[] metaPath = {
      "/computeMetadata/v1/project/numeric-project-id", //  (pending)
      "/computeMetadata/v1/project/project-id",
      "/computeMetadata/v1/instance/zone",
      "/computeMetadata/v1/instance/service-accounts/default/aliases",
      "/computeMetadata/v1/instance/service-accounts/default/email",
      "/computeMetadata/v1/instance/service-accounts/default/",
      "/computeMetadata/v1/instance/service-accounts/default/scopes",
      // Tokens work - but are a security risk to display
      //      "/computeMetadata/v1/instance/service-accounts/default/token"
  };

  final String[] metaServiceAcct = {
      "/computeMetadata/v1/instance/service-accounts/{account}/aliases",
      "/computeMetadata/v1/instance/service-accounts/{account}/email",
      "/computeMetadata/v1/instance/service-accounts/{account}/scopes",
      // Tokens work - but are a security risk to display
      //     "/computeMetadata/v1/instance/service-accounts/{account}/token"
  };

  private final String metadata = "http://metadata.google.internal";
  private TemplateEngine templateEngine;

  // Use OkHttp from Square as it's quite easy to use for simple fetches.
  private final OkHttpClient ok = new OkHttpClient.Builder()
      .readTimeout(500, TimeUnit.MILLISECONDS)  // Don't dawdle
      .writeTimeout(500, TimeUnit.MILLISECONDS)
      .build();

  // Setup to pretty print returned json
  private final Gson gson = new GsonBuilder()
      .setPrettyPrinting()
      .create();
  private final JsonParser jp = new JsonParser();

  // Fetch Metadata
  String fetchMetadata(String key) throws IOException {
    Request request = new Request.Builder()
        .url(metadata + key)
        .addHeader("Metadata-Flavor", "Google")
        .get()
        .build();

    Response response = ok.newCall(request).execute();
    return response.body().string();
  }

  String fetchJsonMetadata(String prefix) throws IOException {
    Request request = new Request.Builder()
        .url(metadata + prefix)
        .addHeader("Metadata-Flavor", "Google")
        .get()
        .build();

    Response response = ok.newCall(request).execute();

    // Convert json to prety json
    return gson.toJson(jp.parse(response.body().string()));
  }

  @Override
  public void init() {
    // Setup ThymeLeaf
    ServletContextTemplateResolver templateResolver =
        new ServletContextTemplateResolver(this.getServletContext());

    templateResolver.setPrefix("/WEB-INF/templates/");
    templateResolver.setSuffix(".html");
    templateResolver.setCacheTTLMs(Long.valueOf(1200000L)); // TTL=20m

    // Cache is set to true by default. Set to false if you want templates to
    // be automatically updated when modified.
    templateResolver.setCacheable(true);

    templateEngine = new TemplateEngine();
    templateEngine.setTemplateResolver(templateResolver);
  }

  @Override
  public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    String defaultServiceAccount = "";
    WebContext ctx = new WebContext(req, resp, getServletContext(), req.getLocale());

    resp.setContentType("text/html");

    String environment =
        (String) System.getProperties().get("com.google.appengine.runtime.environment");
    ctx.setVariable("production", environment);

    // The metadata server is only on a production system
    if (environment.equals("Production")) {

      TreeMap<String, String> m = new TreeMap<>();

      for (String key : metaPath) {
        m.put(key, fetchMetadata(key));
        if (key.contains("default/email")) {
          defaultServiceAccount = m.get(key);
        }
      }

      ctx.setVariable("Metadata", m.descendingMap());

      m = new TreeMap<>();
      for (String key : metaServiceAcct) {
        // substitute a service account for {account}
        key = key.replace("{account}", defaultServiceAccount);
        m.put(key, fetchMetadata(key));
      }
      ctx.setVariable("sam", m.descendingMap());

      // Recursivly get all info about service accounts -- Note tokens are leftout by default.
      ctx.setVariable("rsa",
          fetchJsonMetadata("/computeMetadata/v1/instance/service-accounts/?recursive=true"));
      // Recursivly get all data on Metadata server.
      ctx.setVariable("ram", fetchJsonMetadata("/?recursive=true"));
    }

    templateEngine.process("index", ctx, resp.getWriter());

  }
}

Dans l'exemple de code, notez la vérification visant à vérifier que l'application est exécutée en production. Si l'application s'exécute localement, les demandes ne renverront aucune métadonnée.

Notez également l'utilisation du sérialiseur/désérialiseur Google Gson JSON, du client OkHttp HTTP et HTTP2, et du système de modélisation Thymeleaf. Ceux-ci ne sont pas obligatoires, mais ce sont des bibliothèques utiles pour vos propres projets.

Exécution locale

Le serveur de métadonnées est disponible pour les applications déployées. L'exécution en local sur le serveur de développement n'est pas prise en charge. Vous pouvez ajouter une vérification de l'environnement à votre code pour ne générer des résultats de métadonnées que si l'application est exécutée en production, comme illustré dans l'exemple de code fourni ci-dessus :

String environment =
      (String) System.getProperties().get("com.google.appengine.runtime.environment");
  ctx.setVariable("production", environment);

  // The metadata server is only on a production system
  if (environment.equals("Production")) {
     ... //show metadata results
   }