Стандарти термінології
Щоб забезпечити зрозумілість для наших користувачів, використовуйте стандартні терміни в цьому розділі послідовно в документації.
Сервіс
Уникайте використання терміна сервіс. Дослідження показують, що різні люди розуміють під цим терміном різні речі. Наступна таблиця показує прийнятні альтернативи, які надають більше конкретики та ясності для читачів:
Зробіть | Не робіть |
---|---|
Робоче навантаження A надсилає запит до Робочого навантаження B. | Сервіс A надсилає запит до сервісу B. |
Нові екземпляри робочого навантаження запускаються, коли … | Нові екземпляри сервісу запускаються, коли … |
Застосунок складається з двох робочих навантажень. | Сервіс складається з двох сервісів. |
Наш глосарій визначає узгоджену термінологію та надає визначення, щоб уникнути плутанини.
Envoy
Ми віддаємо перевагу використанню терміна “Envoy”, оскільки це більш конкретний термін, ніж “проксі”, і він краще сприймається, якщо використовується послідовно в документації.
Синоніми:
- “Envoy sidecar” — прийнятно
- “Envoy proxy” — прийнятно
- “Istio proxy” — краще уникати, якщо ви не говорите про розширені сценарії, де може використовуватися інший проксі.
- “Sidecar” — в основному обмежено концептуальною документацією
- “Proxy” — лише якщо контекст зрозумілий
Пов’язані терміни:
- Proxy agent — Це незначний інфраструктурний компонент і має з’являтися лише в документації низького рівня. Це не власна назва.
Різне
Зробіть | Не робіть |
---|---|
addon | add-on |
Bookinfo | BookInfo , bookinfo |
certificate | cert |
colocate | co-locate |
configuration | config |
delete | kill |
Kubernetes | kubernetes , k8s |
load balancing | load-balancing |
Mixer | mixer |
multicluster | multi-cluster |
mutual TLS | mtls |
service mesh | Service Mesh |
sidecar | side-car , Sidecar |