sigs.k8s.io/gateway-api@v1.0.0/site-src/guides/index.md (about)

     1  # Getting started with Gateway API
     2  
     3  **1.**  **[Install a Gateway controller](#installing-a-gateway-controller)**
     4   _OR_  **[install the Gateway API CRDs manually](#installing-gateway-api)**
     5  
     6  _THEN_
     7  
     8  **2.**   **Try out one of the available guides:**
     9  
    10  - [Simple Gateway](/guides/simple-gateway) (a good one to start out with)
    11  - [HTTP routing](/guides/http-routing)
    12  - [HTTP redirects and rewrites](/guides/http-redirect-rewrite)
    13  - [HTTP traffic splitting](/guides/traffic-splitting)
    14  - [Routing across Namespaces](/guides/multiple-ns)
    15  - [Configuring TLS](/guides/tls)
    16  - [TCP routing](/guides/tcp)
    17  - [gRPC routing](/guides/grpc-routing)
    18  - [Migrating from Ingress](/guides/migrating-from-ingress)
    19  
    20  ## Installing a Gateway controller
    21  
    22  There are [multiple projects](/implementations) that support the
    23  Gateway API. By installing a Gateway controller in your Kubernetes cluster,
    24  you can try out the guides above. This will demonstrate that the desired routing
    25  configuration is actually being implemented by your Gateway resources (and the
    26  network infrastructure that your Gateway resources represent). Note that many
    27  of the Gateway controller setups will install and remove the Gateway API bundle
    28  for you.
    29  
    30  ## Installing Gateway API
    31  
    32  A Gateway API bundle represents the set of CRDs and validating webhook
    33  associated with a version of Gateway API. Each release includes two
    34  channels with different levels of stability:
    35  
    36  ### Install Standard Channel
    37  
    38  The standard release channel includes all resources that have graduated to beta,
    39  including GatewayClass, Gateway, ReferenceGrant, and HTTPRoute. To install this
    40  channel, run the following kubectl command:
    41  
    42  ```
    43  kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
    44  ```
    45  
    46  ### Install Experimental Channel
    47  
    48  The experimental release channel includes everything in the standard release
    49  channel plus some experimental resources and fields. This includes
    50  TCPRoute, TLSRoute, UDPRoute and GRPCRoute.
    51  
    52  Note that future releases of the API could include breaking changes to
    53  experimental resources and fields. For example, any experimental resource or
    54  field could be removed in a future release. For more information on the
    55  experimental channel, refer to our [versioning
    56  documentation](https://gateway-api.sigs.k8s.io/concepts/versioning/).
    57  
    58  To install the experimental channel, run the following kubectl command:
    59  
    60  ```
    61  kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/experimental-install.yaml
    62  ```
    63  
    64  ### Cleanup
    65  After you're done, you can clean up after yourself by uninstalling the Gateway
    66  API CRDs and webhook by replacing "apply" with "delete" in the commands above.
    67  If these resources are in-use or if they were installed by a Gateway controller,
    68  then do not uninstall them. This will uninstall the Gateway API resources for
    69  the entire cluster. Do not do this if they might be in-use by someone else as
    70  this will break anything using these resources.