Skip to content

Commit da461c6

Browse files
committed
updated docs search interface and fixed helm chart settings
1 parent 158608b commit da461c6

File tree

4 files changed

+81
-1
lines changed

4 files changed

+81
-1
lines changed

documentation/docs/tech-docs/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import dedent from 'ts-dedent'
3030
helm upgrade in-cloud-web oci://registry-1.docker.io/prorobotech/incloud-web-chart \\
3131
--namespace in-cloud-web \\
3232
--install \\
33-
--set in-cloud-web-resources.enabled=false \\
33+
--set incloud-web-resources.enabled=false \\
3434
--set fullnameOverride=in-cloud-web
3535
`}
3636
</CodeBlock>

documentation/docs/tech-docs/settings.mdx

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1950,6 +1950,48 @@ import { FancyboxImage } from '@site/src/components/commonBlocks/FancyboxImage'
19501950
</td>
19511951
</tr>
19521952

1953+
<tr>
1954+
<td><code>LabelsToSearchParams</code></td>
1955+
<td>Создает ссылку на Search модуль с подставленными атрибутами поиска</td>
1956+
<td>
1957+
<figure style={{ textAlign: 'center', display: 'contents' }}>
1958+
<FancyboxImage src={`${getBasePrefix()}img/in-cloud/components/LabelsToSearchParams.drawio.svg`} style={{ width: '100%', maxWidth: 'none' }} />
1959+
<figcaption style={{ marginTop: '0.5rem', fontSize: '0.9rem', color: '#666', textAlign: 'center' }}>
1960+
</figcaption>
1961+
</figure>
1962+
<div style={{ display: 'flex', gap: '0.5rem', flexWrap: 'wrap', marginTop: '1rem' }}>
1963+
<YamlModal
1964+
yamlContent={dedent`
1965+
- type: LabelsToSearchParams
1966+
data:
1967+
id: example-to-search-params
1968+
reqIndex: 0
1969+
jsonPathToLabels: ".metadata.labels"
1970+
linkPrefix: "/openapi-ui/{2}/search?kinds=~v1~pods&labels="
1971+
errorText: "No selector"
1972+
maxTextLength: 11
1973+
textLink: Search
1974+
`}
1975+
/>
1976+
<YamlModal
1977+
buttonLabel="Пример структуры"
1978+
yamlContent={dedent`
1979+
{
1980+
id: number | string
1981+
reqIndex: number
1982+
jsonPathToLabels: string
1983+
linkPrefix: string
1984+
errorText: string
1985+
maxTextLength: number
1986+
textLink: string
1987+
style?: CSSProperties
1988+
}
1989+
`}
1990+
/>
1991+
</div>
1992+
</td>
1993+
</tr>
1994+
19531995
<tr>
19541996
<td><code>StatusText</code></td>
19551997
<td>Определяет статус по значениям (успех, ошибка, ожидание)</td>
@@ -3473,6 +3515,36 @@ Factory поддерживает версионность API. Вы можете
34733515
</tbody>
34743516
</table>
34753517

3518+
3519+
### Search
3520+
3521+
Страница <code>Search</code> предназначена для поиска ресурсов Kubernetes по имени, типу, лейблам и кастомным полям в рамках выбранного кластера.
3522+
3523+
Она доступна из бокового меню интерфейса и также поддерживает callback-ссылки из форм создания и редактирования ресурсов, что позволяет быстро перейти к списку найденных объектов после выполнения операций.
3524+
3525+
#### Пути доступа
3526+
3527+
<details>
3528+
<summary>Доступные маршруты</summary>
3529+
3530+
- <code>/openapi-ui/\{clusterName}/\{namespace}/search</code> — поиск с указанием пространства имён.
3531+
- <code>/openapi-ui/\{clusterName}/search</code> — глобальный поиск по кластеру.
3532+
</details>
3533+
3534+
<figure style={{ textAlign: 'center', display: 'contents' }}>
3535+
<FancyboxImage
3536+
src={`${getBasePrefix()}img/in-cloud/interfaces/search.drawio.svg`}
3537+
style={{ width: '100%', maxWidth: 'none' }}
3538+
/>
3539+
<figcaption style={{ marginTop: '0.5rem', fontSize: '0.9rem', color: '#666', textAlign: 'center' }}>
3540+
Схема взаимодействия интерфейса страницы <code>Search</code> с кластером Kubernetes
3541+
</figcaption>
3542+
</figure>
3543+
3544+
:::note
3545+
Страница <code>Search</code> является частью общей системы визуализации Factory и использует единый механизм отображения данных, включая поддержку фильтрации, подсветку совпадений и контекстные переходы.
3546+
:::
3547+
34763548
---
34773549
:::info Информация
34783550
> Что-то непонятно или нашли ошибку? Напишите нам — поможем разобраться.

documentation/static/img/in-cloud/components/LabelsToSearchParams.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

documentation/static/img/in-cloud/interfaces/search.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)