You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove duplicated content in concepts and reference
We currently have quite some contents duplicated between the concepts
and the reference section, which is not good. This PR is an effort to
remove the duplicated content from the two pages while providing links
for readers to check the reference easily.
@@ -78,95 +71,58 @@ You can request the response format using request headers as follows:
78
71
<caption>Valid request header values for OpenAPI v2 queries</caption>
79
72
</table>
80
73
81
-
Kubernetes implements an alternative Protobuf based serialization format for the API that is primarily intended for intra-cluster communication, documented in the [design proposal](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/protobuf.md) and the IDL files for each schema are located in the Go packages that define the API objects.
82
-
83
-
## API versioning
84
-
85
-
To make it easier to eliminate fields or restructure resource representations, Kubernetes supports
86
-
multiple API versions, each at a different API path, such as `/api/v1` or
87
-
`/apis/rbac.authorization.k8s.io/v1alpha1`.
88
-
89
-
Versioning is done at the API level rather than at the resource or field level to ensure that the
90
-
API presents a clear, consistent view of system resources and behavior, and to enable controlling
91
-
access to end-of-life and/or experimental APIs.
74
+
Kubernetes implements an alternative Protobuf based serialization format that
75
+
is primarily intended for intra-cluster communication. For more information
76
+
about this format, see the [Kubernetes Protobuf serialization](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/protobuf.md) design proposal and the
77
+
Interface Definition Language (IDL) files for each schema located in the Go
78
+
packages that define the API objects.
92
79
93
-
The JSON and Protobuf serialization schemas follow the same guidelines for schema changes - all descriptions below cover both formats.
94
-
95
-
Note that API versioning and Software versioning are only indirectly related. The
- The version names contain `alpha` (e.g. `v1alpha1`).
106
-
- May be buggy. Enabling the feature may expose bugs. Disabled by default.
107
-
- Support for feature may be dropped at any time without notice.
108
-
- The API may change in incompatible ways in a later software release without notice.
109
-
- Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
110
-
- Beta level:
111
-
- The version names contain `beta` (e.g. `v2beta3`).
112
-
- Code is well tested. Enabling the feature is considered safe. Enabled by default.
113
-
- Support for the overall feature will not be dropped, though details may change.
114
-
- The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens,
115
-
we will provide instructions for migrating to the next version. This may require deleting, editing, and re-creating
116
-
API objects. The editing process may require some thought. This may require downtime for applications that rely on the feature.
117
-
- Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases. If you have
118
-
multiple clusters which can be upgraded independently, you may be able to relax this restriction.
119
-
-**Please do try our beta features and give feedback on them! Once they exit beta, it may not be practical for us to make more changes.**
120
-
- Stable level:
121
-
- The version name is `vX` where `X` is an integer.
122
-
- Stable versions of features will appear in released software for many subsequent versions.
123
-
124
-
## API groups
125
-
126
-
To make it easier to extend its API, Kubernetes implements [*API groups*](https://git.k8s.io/community/contributors/design-proposals/api-machinery/api-group.md).
127
-
The API group is specified in a REST path and in the `apiVersion` field of a serialized object.
128
-
129
-
There are several API groups in a cluster:
80
+
## API changes
130
81
131
-
1. The *core* group, also referred to as the *legacy* group, is at the REST path `/api/v1` and uses `apiVersion: v1`.
82
+
Any system that is successful needs to grow and change as new use cases emerge or existing ones change.
83
+
Therefore, Kubernetes has designed its features to allow the Kubernetes API to continuously change and grow.
84
+
The Kubernetes project aims to _not_ break compatibility with existing clients, and to maintain that
85
+
compatibility for a length of time so that other projects have an opportunity to adapt.
132
86
133
-
1.*Named* groups are at REST path `/apis/$GROUP_NAME/$VERSION`, and use `apiVersion: $GROUP_NAME/$VERSION`
134
-
(e.g. `apiVersion: batch/v1`). The Kubernetes [API reference](/docs/reference/kubernetes-api/) has a
135
-
full list of available API groups.
87
+
In general, new API resources and new resource fields can be added often and frequently.
88
+
Elimination of resources or fields requires following the
0 commit comments