paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

Correcting namespace format rules in catalog documentation

Browse Source 
Signed-off-by: olangen <oliver.langen@nokia.com>
This commit is contained in:
olangen
2023-05-12 08:06:49 +00:00
parent 56669e3d03
commit f4af5d4d15
1 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/descriptor-format.md
+11 -7
View File
@@ -239,18 +239,22 @@ Example: `visits-tracking-service`, `CircleciBuildsDumpV2_avro_gcs`
### `namespace` [optional]
The ID of a namespace that the entity belongs to. This is a string that follows
the same format restrictions as `name` above.
The ID of a namespace that the entity belongs to. This field is optional, and
currently has no special semantics apart from bounding the name uniqueness
constraint if specified. It is reserved for future use and may get broader
semantic implication later.
This field is optional, and currently has no special semantics apart from
bounding the name uniqueness constraint if specified. It is reserved for future
use and may get broader semantic implication later. For now, it is recommended
to not specify a namespace unless you have specific need to do so. This means
the entity belongs to the `"default"` namespace.
For now, it is recommended to not specify a namespace unless you have specific
need to do so. This means the entity belongs to the `"default"` namespace.
Namespaces may also be part of the catalog, and are `v1` / `Namespace` entities,
i.e. not Backstage specific but the same as in Kubernetes.
Namespaces must be sequences of `[a-zA-Z0-9]`, possibly separated by `-`, at
most 63 characters in total.
Example: `tracking-services`, `CircleciV2-Entities`
### `uid` [output]
Each entity gets an automatically generated globally unique ID when it first