sigs.k8s.io/gateway-api@v1.0.0/README.md (about)

     1  # Kubernetes Gateway API
     2  
     3  The Gateway API is a part of [SIG Network][sn], and this repository contains
     4  the specification and Custom Resource Definitions (CRDs).
     5  
     6  ## Status
     7  
     8  The latest supported version is `v1beta1` as released by the [v1.0.0
     9  release](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.0.0) of
    10  this project.
    11  
    12  This version of the API is has beta level support for the following resources:
    13  
    14  - `v1beta1.GatewayClass`
    15  - `v1beta1.Gateway`
    16  - `v1beta1.HTTPRoute`
    17  - `v1beta1.ReferenceGrant`
    18  
    19  For all other APIs we provide alpha level support.
    20  
    21  ## Documentation
    22  
    23  ### Website
    24  
    25  The API specification and detailed documentation is available on the project
    26  website: [https://gateway-api.sigs.k8s.io][ghp].
    27  
    28  ### Concepts
    29  
    30  To get started, please read through [API concepts][concepts] and
    31  [Security model][security-model]. These documents give the necessary background
    32  to understand the API and the use-cases it targets.
    33  
    34  ### Getting started
    35  
    36  Once you have a good understanding of the API at a higher-level, check out
    37  [getting started][getting-started] to install your first Gateway controller and try out
    38  one of the guides.
    39  
    40  ### References
    41  
    42  A complete API reference, please refer to:
    43  
    44  - [API reference][spec]
    45  - [Go docs for the package](https://pkg.go.dev/sigs.k8s.io/gateway-api/apis/v1alpha2)
    46  
    47  ## Contributing
    48  
    49  Community meeting schedule, notes and developer guide can be found on the
    50  [community page][cm].
    51  Our Kubernetes Slack channel is [#sig-network-gateway-api][slack].
    52  
    53  ### Code of conduct
    54  
    55  Participation in the Kubernetes community is governed by the
    56  [Kubernetes Code of Conduct](code-of-conduct.md).
    57  
    58  [ghp]: https://gateway-api.sigs.k8s.io/
    59  [sn]: https://github.com/kubernetes/community/tree/master/sig-network
    60  [cm]: https://gateway-api.sigs.k8s.io/contributing/community
    61  [slack]: https://kubernetes.slack.com/messages/sig-network-gateway-api
    62  [getting-started]: https://gateway-api.sigs.k8s.io/v1alpha2/guides
    63  [spec]: https://gateway-api.sigs.k8s.io/v1alpha2/reference/spec
    64  [concepts]: https://gateway-api.sigs.k8s.io/concepts/api-overview
    65  [security-model]: https://gateway-api.sigs.k8s.io/concepts/security-model