Skip to content
This repository was archived by the owner on Apr 17, 2025. It is now read-only.

Commit 393ac87

Browse files
committed
Update docs for v1.1
1 parent 564b4a9 commit 393ac87

File tree

4 files changed

+17
-34
lines changed

4 files changed

+17
-34
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ my-team
1010
Hierarchical namespaces make it easier to share your cluster by making
1111
namespaces more powerful. For example, you can create additional namespaces
1212
under your team's namespace, even if you don't have cluster-level permission to
13-
create namespaces, and easily apply policies like RBAC and Network Policies
14-
across all namespaces in your team (e.g. a set of related microservices).
13+
create namespaces, and easily apply policies like RBAC, Network Policies, and
14+
(beta in v1.1) hierarchical resource quotas across all namespaces in your team
15+
(e.g. a set of related microservices).
1516

1617
Learn more in the [HNC User Guide](docs/user-guide) or get started with the
1718
instructions below!
@@ -27,8 +28,6 @@ Lead developer: @adrianludwin ([email protected])
2728
To install HNC on your cluster, and the `kubectl-hns` plugin on your
2829
workstation, follow the instructions on our [release
2930
pages](https://github.com/kubernetes-sigs/hierarchical-namespaces/releases/).
30-
Note that versions of HNC prior to HNC v0.9 are available from our [old
31-
repo](https://github.com/kubernetes-sigs/multi-tenancy/releases/).
3231

3332
Once HNC is installed, you can try out the [HNC
3433
quickstart](docs/user-guide/quickstart.md)
@@ -43,14 +42,17 @@ feature requests will be prioritized and assigned to a milestone or backlog.
4342
All HNC issues are assigned to an HNC milestone. So far, the following
4443
milestones are defined or planned:
4544

45+
* [v1.2](https://github.com/kubernetes-sigs/hierarchical-namespaces/milestone/5):
46+
HRQ to GA; server-side listing; stability improvements (ETA late 2023)
4647
* [v1.1](https://github.com/kubernetes-sigs/hierarchical-namespaces/milestone/3):
47-
Hierarchical quotas; inclusive propagation.
48+
Hierarchical quotas; inclusive propagation (released June 23 2023)
4849
* [v1.0](https://github.com/kubernetes-sigs/hierarchical-namespaces/milestone/2):
4950
HNC recommended for production use (released March 31 2022)
50-
* [v0.9](https://github.com/kubernetes-sigs/hierarchical-namespaces/milestone/1):
51-
move HNC to its own repo; continued stability improvements.
52-
* [v0.1-v0.8](https://github.com/kubernetes-sigs/multi-tenancy/milestones):
53-
see our old repo for details.
51+
52+
### Older versions
53+
54+
That versions of HNC prior to HNC v0.9 are available from our [old
55+
repo](https://github.com/kubernetes-sigs/multi-tenancy/releases/).
5456

5557
## Contact and governance
5658

docs/releasing.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,7 @@ that anyone can use, but without leaking personal access tokens._
3535
## Document new/changed features
3636

3737
Ensure that the [user guide](user-guide/) is up-to-date with all the latest or
38-
changed features. _This must be done on the master branch **before** creating
39-
the release branch._ We used to remove instructions for old versions of HNC, but
40-
since v1.0 this should no longer be necessary as it's not changing as quickly.
38+
changed features.
4139

4240
## Create a release branch
4341

@@ -137,15 +135,14 @@ warning. If this was a release candidate, you're done.
137135
Otherwise, update the [README](../README.md#start) and [user
138136
guide](user-guide/how-to.md#admin-install) to refer to your new release.
139137

140-
If this was a patch release _and you need to document something_, ensure you
141-
document it on _both_ the master _and_ the release branch.
138+
As of HNC v1.0, there is no need to update the docs on the branches.
142139

143140
## Update Krew
144141

145-
Starting with HNC v0.6.x, the build process also generates a Krew tarball and
142+
The build process also generates a Krew tarball and
146143
manifest. This manifest should be downloaded and checked into the Krew index,
147144
*if* it's for the latest branch (and is not a release candidate). E.g. if you've
148-
already released HNC v0.7.0 and have to release HNC v0.6.1, do *not* update the
145+
already released HNC v1.1.0 and have to release HNC v1.0.1, do *not* update the
149146
Krew index; Krew can only support one version of a plugin at a time so we should
150147
only support the most recent branch.
151148

docs/user-guide/README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# HNC User Guide v1.1
1+
# HNC User Guide
22

33
Authors: [email protected] and other contributors from wg-multitenancy
44

@@ -12,23 +12,10 @@ This guide explains how to use hierarchical namespaces, explains some of the
1212
concepts behind them for a more in-depth understanding, and covers some best
1313
practices.
1414

15-
**Note: this doc covers HNC v1.0 and later.** For older versions of HNC, see
16-
below.
17-
1815
## Table of contents
1916

2017
* [Quickstart](quickstart.md): Quickly get going with HNC
2118
* [How-to](how-to.md): Perform common tasks when working with HNC
2219
* [Concepts](concepts.md): Learn more about the ideas behind HNC
2320
* [Best practices](best-practices.md): learn about the best ways to deploy HNC
2421
* [FAQs](faq.md): contact us, requirements, limitations and whatnot
25-
26-
## Older user guides
27-
28-
* [HNC v0.9](https://github.com/kubernetes-sigs/hierarchical-namespaces/tree/hnc-v0.9/docs/user-guide)
29-
* [HNC v0.8](https://github.com/kubernetes-sigs/multi-tenancy/tree/hnc-v0.8/incubator/hnc/docs/user-guide)
30-
* [HNC v0.7](https://github.com/kubernetes-sigs/multi-tenancy/tree/hnc-v0.7/incubator/hnc/docs/user-guide)
31-
* [HNC v0.6](https://github.com/kubernetes-sigs/multi-tenancy/tree/hnc-v0.6/incubator/hnc/docs/user-guide)
32-
* [HNC v0.5](https://github.com/kubernetes-sigs/multi-tenancy/tree/hnc-v0.5/incubator/hnc/docs/user-guide)
33-
* [HNC v0.4](https://github.com/kubernetes-sigs/multi-tenancy/tree/hnc-v0.4/incubator/hnc/docs/user-guide)
34-
* [HNC v0.3](https://docs.google.com/document/d/1XVVv1ha4j1WUaszu3mmlACeWPUJXbJhA6zntxswrsco)

docs/user-guide/how-to.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -492,9 +492,6 @@ namespace will be silently ignored. This will eventually
492492

493493
### Install or upgrade HNC on a cluster
494494

495-
HNC requires Kubernetes v1.16 or later, since it relies on APIs (such as CRDs
496-
and webhooks) that were only introduced in v1.16.
497-
498495
There is no need to uninstall HNC before upgrading it unless specified in the
499496
release notes for that version.
500497

@@ -980,4 +977,4 @@ Interesting parameters include:
980977
exclude an object from propagation.
981978
* Rancher objects that have the label `cattle.io/creator=norman` are not propagated
982979
by the default manifests (refer to [Concepts: built in exceptions](concepts.md#built-in-exceptions)
983-
for more information).
980+
for more information).

0 commit comments

Comments
 (0)