Path Energy Traffic Ratio API (PETRA)
draft-petra-path-energy-api-01

PANRG                                                 A. Rodriguez-Natal
Internet-Draft                                                     Cisco
Intended status: Informational                           L. M. Contreras
Expires: 19 September 2024                                      A. Muniz
                                                              Telefonica
                                                              M. Palmero
                                                                F. Munoz
                                                                   Cisco
                                                           18 March 2024

                 Path Energy Traffic Ratio API (PETRA)
                     draft-petra-path-energy-api-01

Abstract

   This document describes an API to query a network regarding its
   Energy Traffic Ratio for a given path.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 19 September 2024.

Copyright Notice

   Copyright (c) 2024 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Rodriguez-Natal, et al. Expires 19 September 2024               [Page 1]
Internet-Draft                 Energy-API                     March 2024

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Revised BSD License text as
   described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Revised BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology and Requirements Notation . . . . . . . . . . . .   2
   3.  Path Energy Traffic Ratio API (PETRA) . . . . . . . . . . . .   3
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   4
   5.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .   4
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   4
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .   4
     7.2.  Informative References  . . . . . . . . . . . . . . . . .   4
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   5

1.  Introduction

   Sustainability is becoming one of the major societal goals for the
   next decade, and networks are one of the major consumers of energy
   nowadays.  Sustainability of network services is thus one of the
   forefronts of innovation and action from network service
   stakeholders, involving manufacturers, operators and customers.  In
   this line, there is a shared goal of achieving better energy
   awareness.

   As with any other network metric, the energy traffic ratio could be
   collected from the underlying network infrastructure.  However, there
   is not a common or single definition of energy metrics towards
   network consumers so that can be uniformly reported, particularly in
   heterogeneous network scenarios.  This document introduces an API to
   query networks about Energy Traffic Ratio.

2.  Terminology and Requirements Notation

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in BCP
   14 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

Rodriguez-Natal, et al. Expires 19 September 2024               [Page 2]
Internet-Draft                 Energy-API                     March 2024

3.  Path Energy Traffic Ratio API (PETRA)

   This section describes an API to query a network about the Energy
   Traffic Ratio for a given path.  It takes as input the source and
   destination of a path along with the traffic throughput between and
   returns the Energy Traffic Ratio in Watts per Gigabit.  This is
   energy computed by the infrastructure that is dynamically part of the
   traffic path.  This document only describes the API, the computation
   of the Watts per Gigabit to return is out of the scope of this
   document.  The API is modeled following the OpenAPI Specification.

openapi: 3.0.3
info:
  title: Energy API
  version: 1.0.1
paths:
  /energy:
    get:
      tags:
        - energy
      summary: Query the network for energy consupmtion
      description: ''
      operationId: energyQuery
      parameters:
        - name: src-ip
          in: query
          description: Source IP address
          required: true
          schema:
            type: string
        - name: dst-ip
          in: query
          description: Destination IP address
          required: true
          schema:
            type: string
        - name: throughput
          in: query
          description: Throughput between source and destination (in gigabits per second)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:

Rodriguez-Natal, et al. Expires 19 September 2024               [Page 3]
Internet-Draft                 Energy-API                     March 2024

                $ref: '#/components/schemas/energy'
        '400':
          description: Invalid source/destination IP address supplied
components:
  schemas:
    energy:
      type: object
      properties:
        watts-per-gigabit:
          type: number
          format: float
          description: Watts consumed per Gigabit transmitted
        carbon-intensity:
          type: number
          format: integer
          description: Grams of CO2 per kWh

4.  Security Considerations

   TBD

5.  Acknowledgments

   Kudos to Elis Lulja for his help with the OpenAPI specification.
   Thanks to Fernando Sanz Garcia and Lori Jakab for their help and
   support on this work.  The contribution of Telefonica to this work
   has been supported by the HORIZON-JU-SNS2022 Research and Innovation
   Action project 6Green (Grant Agreement no. 101096925).

6.  IANA Considerations

   This document makes no request to IANA.

7.  References

7.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

   [RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
              2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
              May 2017, <https://www.rfc-editor.org/info/rfc8174>.

7.2.  Informative References

Rodriguez-Natal, et al. Expires 19 September 2024               [Page 4]
Internet-Draft                 Energy-API                     March 2024

Authors' Addresses

   Alberto Rodriguez-Natal
   Cisco
   Barcelona
   Spain
   Email: natal@cisco.com

   Luis M. Contreras
   Telefonica
   Madrid
   Spain
   Email: luismiguel.contrerasmurillo@telefonica.com

   Alejandro Muniz
   Telefonica
   Madrid
   Spain
   Email: alejandro.muniz@telefonica.com

   Marisol Palmero
   Cisco
   Madrid
   Spain
   Email: mpalmero@cisco.com

   Fernando Munoz
   Cisco
   Madrid
   Spain
   Email: fmunozma@cisco.com

Rodriguez-Natal, et al. Expires 19 September 2024               [Page 5]