Skip to content

Commit

Permalink
Add “API group” to glossary #15906 (#16192)
Browse files Browse the repository at this point in the history
Created API Group glossary term
Linked glossary term to applicable pages
  • Loading branch information
ashishbharthi authored and k8s-ci-robot committed Oct 23, 2019
1 parent 8d51203 commit 3c88fb1
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
Expand Up @@ -52,7 +52,7 @@ Kubernetes reviews only the following API request attributes:
* **Resource** - The ID or name of the resource that is being accessed (for resource requests only) -- For resource requests using `get`, `update`, `patch`, and `delete` verbs, you must provide the resource name.
* **Subresource** - The subresource that is being accessed (for resource requests only).
* **Namespace** - The namespace of the object that is being accessed (for namespaced resource requests only).
* **API group** - The API group being accessed (for resource requests only). An empty string designates the [core API group](/docs/concepts/overview/kubernetes-api/).
* **API group** - The {{< glossary_tooltip text="API Group" term_id="api-group" >}} being accessed (for resource requests only). An empty string designates the [core API group](/docs/concepts/overview/kubernetes-api/).

## Determine the Request Verb

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/reference/access-authn-authz/rbac.md
Expand Up @@ -13,7 +13,7 @@ Role-based access control (RBAC) is a method of regulating access to computer or
{{% /capture %}}

{{% capture body %}}
`RBAC` uses the `rbac.authorization.k8s.io` API group
`RBAC` uses the `rbac.authorization.k8s.io` {{< glossary_tooltip text="API Group" term_id="api-group" >}}
to drive authorization decisions, allowing admins to dynamically configure policies
through the Kubernetes API.

Expand Down Expand Up @@ -286,7 +286,7 @@ rules:

Only the `rules` section is shown in the following examples.

Allow reading the resource "pods" in the core API group:
Allow reading the resource "pods" in the core {{< glossary_tooltip text="API Group" term_id="api-group" >}}:

```yaml
rules:
Expand Down
19 changes: 19 additions & 0 deletions content/en/docs/reference/glossary/api-group.md
@@ -0,0 +1,19 @@
---
title: API Group
id: api-group
date: 2019-09-02
full_link: /docs/concepts/overview/kubernetes-api/#api-groups
short_description: >
A set of related paths in the Kubernetes API.
aka:
tags:
- fundamental
- architecture
---
A set of related paths in Kubernetes API.

<!--more-->
You can enable or disable each API group by changing the configuration of your API server. You can also disable or enable paths to specific resources. API group makes it easier to extend the Kubernetes API. The API group is specified in a REST path and in the `apiVersion` field of a serialized object.

* Read [API Group](/docs/concepts/overview/kubernetes-api/#api-groups) for more information.

0 comments on commit 3c88fb1

Please sign in to comment.