Skip to content

Commit

Permalink
Update on periods in service name (#97)
Browse files Browse the repository at this point in the history
Co-authored-by: Ori Shoshan <[email protected]>
  • Loading branch information
NetanelBollag and orishoshan committed Jun 29, 2023
1 parent 1d50b7d commit 8f05753
Show file tree
Hide file tree
Showing 5 changed files with 391 additions and 12,975 deletions.
7 changes: 4 additions & 3 deletions docs/reference/service-identities/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ Otterize uses universal service identities to refer to services, regardless of w
How do Otterize operators decide what is the name of the service that runs within the pod? The algorithm is as follows:

1. If the pod has an `intents.otterize.com/service-name` label, its value is used as the service name. This allows developers and
automations to explicitly name services, if needed.
2. If there is no `intents.otterize.com/service-name` label, a recursive look up is performed for the Kubernetes resource owner of
automations to explicitly name services, if needed. The value must not contain a period `.` as a period is used to separate service name and namespace, when the service is from a different namespace: `svcname.namespace`.
2. If there is no `intents.otterize.com/service-name` label, a recursive look-up is performed for the Kubernetes resource owner of
the pod, until the root resource is reached, and its name is used as the service name. For example, if you have
a `Deployment` named `checkoutservice`, which then creates and owns a `ReplicaSet`, which then creates and owns
a `Pod`, then the service name for that pod is `checkoutservice` - same as the name of the `Deployment`. This is
intended to capture the likely-more-meaningful "human name" of the service.
intended to capture the likely-more-meaningful "human name" of the service. If the resulting service name contains
a period `.`, it is replaced with an underscore `_`. Periods are used in service names to denote namespaces, e.g. `svcname.namespace`.
15 changes: 14 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,21 @@ const config = {
{ src: "/pixels.js", async: true },
],
plugins: [
['@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/getting-started/oss-installation',
to: '/installation',
},
// Redirect from multiple old paths to the new path
// {
// to: '/docs/newDoc2',
// from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
// },
],
}],
["docusaurus-plugin-includes", {}],
["docusaurus-plugin-hotjar", {}],
[
"@docusaurus/plugin-google-gtag",
{
Expand Down
Loading

0 comments on commit 8f05753

Please sign in to comment.