Skip to content

[SWARM-473]: Версионирование #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dosmth wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[SWARM-473]: Версионирование #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9c1ef6f
version util
Apr 10, 2024
c7c10ed
versioned snippets
Apr 12, 2024
f00f872
fix links
Apr 12, 2024
13e7f57
versioned constants
Apr 12, 2024
fade383
remove v1.13.0
Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/docs/info/terminology.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ import { TERMINOLOGY } from '@site/src/constants/terminology.tsx'

# Терминология

<Terminology data={TERMINOLOGY} />
<Terminology data={TERMINOLOGY['v1.13.0']} />
14 changes: 7 additions & 7 deletions documentation/src/snippets/networks/_Api.mdx → ...mentation/docs/snippets/networks/_Api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'
#### Входные параметры

<ul>
<li>`networks[]` - {DICTIONARY.networks.short}</li>
<li>`networks[]` - {DICTIONARY['v1.13.0'].networks.short}</li>
<li>`networks[].name` - название подсети.</li>
<li>`networks[].network` - объект содержащий CIDR подсети</li>
<li>`networks[].network.CIDR` - {DICTIONARY.cidr.short}</li>
<li>`syncOp` - {DICTIONARY.syncOp.short}</li>
<li>`networks[].network.CIDR` - {DICTIONARY['v1.13.0'].cidr.short}</li>
<li>`syncOp` - {DICTIONARY['v1.13.0'].syncOp.short}</li>
</ul>

<div className="scrollable-x">
Expand Down Expand Up @@ -65,11 +65,11 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'
<ul>
<li>
`networks.networks[].name`:
<Restrictions data={RESTRICTIONS.name} />
<Restrictions data={RESTRICTIONS['v1.13.0'].name} />
</li>
<li>
`networks.networks[].network.CIDR`:
<Restrictions data={RESTRICTIONS.cidr} />
<Restrictions data={RESTRICTIONS['v1.13.0'].cidr} />
</li>
</ul>

Expand Down Expand Up @@ -114,8 +114,8 @@ curl '127.0.0.1:9007/v1/sync' \

<h4 className="custom-heading">Возможные ошибки API</h4>

<Codes data = {RESPOND_CODES.invalid_argument} />
<Codes data = {RESPOND_CODES.not_found} />
<Codes data={RESPOND_CODES['v1.13.0'].invalid_argument} />
<Codes data={RESPOND_CODES['v1.13.0'].not_found} />

<h4 className="custom-heading">Диаграмма последовательности</h4>

Expand Down
0 ...ation/src/snippets/networks/_Nftables.mdx → ...tion/docs/snippets/networks/_Nftables.mdx
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ...rc/snippets/networks/_TerraformModule.mdx → ...cs/snippets/networks/_TerraformModule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { DICTIONARY } from '@site/src/constants/dictionary.ts'
import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'

<div className="paragraph">
<p>{DICTIONARY.terraformModule.full}</p>
<p>{DICTIONARY['v1.13.0'].terraformModule.full}</p>
</div>

<div className="scrollable-x">
Expand Down Expand Up @@ -38,11 +38,11 @@ import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'
<ul>
<li>
`name`:
<Restrictions data={RESTRICTIONS.name} />
<Restrictions data={RESTRICTIONS['v1.13.0'].name} />
</li>
<li>
`cidrs[]`:
<Restrictions data={RESTRICTIONS.cidrSet} />
<Restrictions data={RESTRICTIONS['v1.13.0'].cidrSet} />
</li>
</ul>

Expand Down
12 changes: 6 additions & 6 deletions .../snippets/networks/_TerraformResource.mdx → .../snippets/networks/_TerraformResource.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { DICTIONARY } from '@site/src/constants/dictionary.ts'
import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'

<div className="paragraph">
<p>{DICTIONARY.terraformResource.full}</p>
<p>{DICTIONARY['v1.13.0'].terraformResource.full}</p>
</div>

<div className="scrollable-x">
Expand Down Expand Up @@ -39,7 +39,7 @@ import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'
<td>items.key.cidr</td>
<td>да</td>
<td>string</td>
<td>{DICTIONARY.cidr.short}</td>
<td>{DICTIONARY['v1.13.0'].cidr.short}</td>
</tr>
</tbody>
</table>
Expand All @@ -50,19 +50,19 @@ import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'
<ul>
<li>
`items`:
<Restrictions data={RESTRICTIONS.items} />
<Restrictions data={RESTRICTIONS['v1.13.0'].items} />
</li>
<li>
`items.key`:
<Restrictions data={RESTRICTIONS.itemsRuleName_nw} />
<Restrictions data={RESTRICTIONS['v1.13.0'].itemsRuleName_nw} />
</li>
<li>
`items.key.name`:
<Restrictions data={RESTRICTIONS.name} />
<Restrictions data={RESTRICTIONS['v1.13.0'].name} />
</li>
<li>
`items.key.cidr`:
<Restrictions data={RESTRICTIONS.cidr} />
<Restrictions data={RESTRICTIONS['v1.13.0'].cidr} />
</li>
</ul>

Expand Down
61 changes: 31 additions & 30 deletions documentation/src/snippets/s2c-ie/_Api.mdx → documentation/docs/snippets/s2c-ie/_Api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'
#### Входные параметры

<ul>
<li>`$node.rules[]` - {DICTIONARY.rules.short}</li>
<li>`$node.rules[].cidr` - {DICTIONARY.cidrSet.short}</li>
<li>`$node.rules[].sg` - {DICTIONARY.sgLocal.short}</li>
<li>`$node.rules[].logs` - {DICTIONARY.log.short}</li>
<li>`$node.rules[].trace` - {DICTIONARY.trace.short}</li>
<li>`$node.rules[].ports` - {DICTIONARY.ports.short}</li>
<li>`$node.rules[].ports[].d` - {DICTIONARY.dstPorts.short}</li>
<li>`$node.rules[].ports[].s` - {DICTIONARY.srcPorts.short}</li>
<li>`$node.rules[].traffic` - {DICTIONARY.traffic.short}</li>
<li>`$node.rules[].transport` - {DICTIONARY.transport.short}</li>
<li>`$node.rules[].ICMP` - {DICTIONARY.apiIcmp.short}</li>
<li>`$node.rules[].ICMP.IPv` - {DICTIONARY.icmpV.short}</li>
<li>`$node.rules[].ICMP.Types` - {DICTIONARY.icmpTypes.short}</li>
<li>`$node.rules[].action` - {DICTIONARY.action.short}</li>
<li>`$node.rules[].priority` - {DICTIONARY.priorityst.short}</li>
<li>`$node.rules[].priority.some` - {DICTIONARY.priority.short}</li>
<li>`syncOp` - {DICTIONARY.syncOp.short}</li>
<li>`$node.rules[]` - {DICTIONARY['v1.13.0'].rules.short}</li>
<li>`$node.rules[].cidr` - {DICTIONARY['v1.13.0'].cidrSet.short}</li>
<li>`$node.rules[].sg` - {DICTIONARY['v1.13.0'].sgLocal.short}</li>
<li>`$node.rules[].logs` - {DICTIONARY['v1.13.0'].log.short}</li>
<li>`$node.rules[].trace` - {DICTIONARY['v1.13.0'].trace.short}</li>
<li>`$node.rules[].ports` - {DICTIONARY['v1.13.0'].ports.short}</li>
<li>`$node.rules[].ports[].d` - {DICTIONARY['v1.13.0'].dstPorts.short}</li>
<li>`$node.rules[].ports[].s` - {DICTIONARY['v1.13.0'].srcPorts.short}</li>
<li>`$node.rules[].traffic` - {DICTIONARY['v1.13.0'].traffic.short}</li>
<li>`$node.rules[].transport` - {DICTIONARY['v1.13.0'].transport.short}</li>
<li>`$node.rules[].ICMP` - {DICTIONARY['v1.13.0'].apiIcmp.short}</li>
<li>`$node.rules[].ICMP.IPv` - {DICTIONARY['v1.13.0'].icmpV.short}</li>
<li>`$node.rules[].ICMP.Types` - {DICTIONARY['v1.13.0'].icmpTypes.short}</li>
<li>`$node.rules[].action` - {DICTIONARY['v1.13.0'].action.short}</li>
<li>`$node.rules[].priority` - {DICTIONARY['v1.13.0'].priorityst.short}</li>
<li>`$node.rules[].priority.some` - {DICTIONARY['v1.13.0'].priority.short}</li>
<li>`syncOp` - {DICTIONARY['v1.13.0'].syncOp.short}</li>
</ul>

<div className="scrollable-x">
Expand Down Expand Up @@ -214,23 +214,23 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'
<ul>
<li>
`$node.rules[].SG`:
<Restrictions data={RESTRICTIONS.name} />
<Restrictions data={RESTRICTIONS['v1.13.0'].name} />
</li>
<li>
`$node.rules[].CIDR`:
<Restrictions data={RESTRICTIONS.cidr} />
<Restrictions data={RESTRICTIONS['v1.13.0'].cidr} />
</li>
<li>
`$node.rules[].ports[].s`:
<Restrictions data={RESTRICTIONS.srcPorts} />
<Restrictions data={RESTRICTIONS['v1.13.0'].srcPorts} />
</li>
<li>
`$node.rules[].ports[].d`:
<Restrictions data={RESTRICTIONS.dstPorts} />
<Restrictions data={RESTRICTIONS['v1.13.0'].dstPorts} />
</li>
<li>
`$node.rules[].type[]`:
<Restrictions data={RESTRICTIONS.icmpType} />
<Restrictions data={RESTRICTIONS['v1.13.0'].icmpType} />
</li>
</ul>

Expand Down Expand Up @@ -332,8 +332,8 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'

<h4 className="custom-heading">Возможные ошибки API</h4>

<Codes data = {RESPOND_CODES.invalid_argument} />
<Codes data = {RESPOND_CODES.not_found} />
<Codes data = {RESPOND_CODES['v1.13.0'].invalid_argument} />
<Codes data = {RESPOND_CODES['v1.13.0'].not_found} />

<h4 className="custom-heading">Диаграмма последовательности</h4>

Expand Down Expand Up @@ -459,8 +459,8 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'

<h4 className="custom-heading">Возможные ошибки API</h4>

<Codes data = {RESPOND_CODES.invalid_argument} />
<Codes data = {RESPOND_CODES.not_found} />
<Codes data = {RESPOND_CODES['v1.13.0'].invalid_argument} />
<Codes data = {RESPOND_CODES['v1.13.0'].not_found} />

<h4 className="custom-heading">Диаграмма последовательности</h4>

Expand Down Expand Up @@ -584,8 +584,8 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'

<h4 className="custom-heading">Возможные ошибки API</h4>

<Codes data = {RESPOND_CODES.invalid_argument} />
<Codes data = {RESPOND_CODES.not_found} />
<Codes data = {RESPOND_CODES['v1.13.0'].invalid_argument} />
<Codes data = {RESPOND_CODES['v1.13.0'].not_found} />

<h4 className="custom-heading">Диаграмма последовательности</h4>

Expand Down Expand Up @@ -715,8 +715,8 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'

<h4 className="custom-heading">Возможные ошибки API</h4>

<Codes data = {RESPOND_CODES.invalid_argument} />
<Codes data = {RESPOND_CODES.not_found} />
<Codes data = {RESPOND_CODES['v1.13.0'].invalid_argument} />
<Codes data = {RESPOND_CODES['v1.13.0'].not_found} />

<h4 className="custom-heading">Диаграмма последовательности</h4>

Expand Down Expand Up @@ -760,4 +760,5 @@ import Codes from '@site/src/components/commonBlocks/Codes/_Codes.mdx'

</FancyboxDiagram>
</TabItem>

</Tabs>
27 changes: 14 additions & 13 deletions ...ntation/src/snippets/s2c-ie/_Nftables.mdx → ...tation/docs/snippets/s2c-ie/_Nftables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ import { DICTIONARY } from '@site/src/constants/dictionary.ts'
nftables. Это позволяет легко интегрировать сложные правила безопасности прямо в вашу систему фильтрации трафика.
</div>
<ul>
<li>`$Trace` - {DICTIONARY.trace.short}</li>
<li>`$SrcCIDR` - {DICTIONARY.srcDstCidr.short}</li>
<li>`$DstCIDR` - {DICTIONARY.srcDstCidr.short}</li>
<li>`$Transport` - {DICTIONARY.transport.short}</li>
<li>`$NftRuleType` - {DICTIONARY.nftRuleType.short}</li>
<li>`$IcmpTypeList` - {DICTIONARY.icmpTypes.short}</li>
<li className="text-justify">`$SrcPorts` - {DICTIONARY.srcPorts.short}</li>
<li className="text-justify">`$DstPorts` - {DICTIONARY.dstPorts.short}</li>
<li>`$NftCounter` - {DICTIONARY.nftCounter.short}</li>
<li>`$Log` - {DICTIONARY.log.short}</li>
<li>`$NftRuleVerdict` - {DICTIONARY.nftRuleVerdict.short}</li>
<li>`$Trace` - {DICTIONARY['v1.13.0'].trace.short}</li>
<li>`$SrcCIDR` - {DICTIONARY['v1.13.0'].srcDstCidr.short}</li>
<li>`$DstCIDR` - {DICTIONARY['v1.13.0'].srcDstCidr.short}</li>
<li>`$Transport` - {DICTIONARY['v1.13.0'].transport.short}</li>
<li>`$NftRuleType` - {DICTIONARY['v1.13.0'].nftRuleType.short}</li>
<li>`$IcmpTypeList` - {DICTIONARY['v1.13.0'].icmpTypes.short}</li>
<li className="text-justify">`$SrcPorts` - {DICTIONARY['v1.13.0'].srcPorts.short}</li>
<li className="text-justify">`$DstPorts` - {DICTIONARY['v1.13.0'].dstPorts.short}</li>
<li>`$NftCounter` - {DICTIONARY['v1.13.0'].nftCounter.short}</li>
<li>`$Log` - {DICTIONARY['v1.13.0'].log.short}</li>
<li>`$NftRuleVerdict` - {DICTIONARY['v1.13.0'].nftRuleVerdict.short}</li>
</ul>

<div className="scrollable-x">
Expand Down Expand Up @@ -142,10 +142,11 @@ import { DICTIONARY } from '@site/src/constants/dictionary.ts'
<td>
<div className="text-justify">
<i>
$NftRuleVerdict определяет действие, которое будет применено к пакету в соответсвии с правилом. Это поле может принимать значение `accept` или `drop` в зависимости от указанного в правиле.
$NftRuleVerdict определяет действие, которое будет применено к пакету в соответсвии с правилом. Это поле
может принимать значение `accept` или `drop` в зависимости от указанного в правиле.
</i>
</div>
<i>Подробнее: [Verdict statement](/tech-docs/to-nft/nftables/verdict-statement)</i>
<i>Подробнее: [Verdict statement](../../tech-docs/to-nft/nftables/verdict-statement)</i>
</td>
<td className="green center">✔</td>
<td className="green center">✔</td>
Expand Down
40 changes: 20 additions & 20 deletions .../src/snippets/s2c-ie/_TerraformModule.mdx → ...docs/snippets/s2c-ie/_TerraformModule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { DICTIONARY } from '@site/src/constants/dictionary.ts'
import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'

<div className="paragraph">
<p>{DICTIONARY.terraformModule.full}</p>
<p>{DICTIONARY['v1.13.0'].terraformModule.full}</p>
</div>
<div className="paragraph">
Далее везде в документе подразумевается что все места, содержащие переменную `$traffic`, могут принять одно из двух
Expand All @@ -15,19 +15,19 @@ import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'
</div>

<ul>
<li className="text-justify">`rules` - {DICTIONARY.rules.short}</li>
<li className="text-justify">`rules.$traffic[]` - {DICTIONARY.traffic.short}</li>
<li className="text-justify">`rules.$traffic[].cidrSet[]` - {DICTIONARY.cidrSet.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport` - {DICTIONARY.transport.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.action` - {DICTIONARY.action.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.priority` - {DICTIONARY.priority.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.logs` - {DICTIONARY.log.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.trace` - {DICTIONARY.trace.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].description` - {DICTIONARY.description.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].ports_to[]` - {DICTIONARY.dstPorts.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].ports_from[]` - {DICTIONARY.srcPorts.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.types[].description` - {DICTIONARY.description.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.types[].type[]` - {DICTIONARY.icmpTypes.short}</li>
<li className="text-justify">`rules` - {DICTIONARY['v1.13.0'].rules.short}</li>
<li className="text-justify">`rules.$traffic[]` - {DICTIONARY['v1.13.0'].traffic.short}</li>
<li className="text-justify">`rules.$traffic[].cidrSet[]` - {DICTIONARY['v1.13.0'].cidrSet.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport` - {DICTIONARY['v1.13.0'].transport.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.action` - {DICTIONARY['v1.13.0'].action.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.priority` - {DICTIONARY['v1.13.0'].priority.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.logs` - {DICTIONARY['v1.13.0'].log.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.trace` - {DICTIONARY['v1.13.0'].trace.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].description` - {DICTIONARY['v1.13.0'].description.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].ports_to[]` - {DICTIONARY['v1.13.0'].dstPorts.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.ports[].ports_from[]` - {DICTIONARY['v1.13.0'].srcPorts.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.types[].description` - {DICTIONARY['v1.13.0'].description.short}</li>
<li className="text-justify">`rules.$traffic[].access.$transport.types[].type[]` - {DICTIONARY['v1.13.0'].icmpTypes.short}</li>

</ul>

Expand Down Expand Up @@ -179,27 +179,27 @@ import { RESTRICTIONS } from '@site/src/constants/restrictions.tsx'
<ul>
<li>
`name`:
<Restrictions data={RESTRICTIONS.name} />
<Restrictions data={RESTRICTIONS['v1.13.0'].name} />
</li>
<li>
`rules.$traffic[].cidrSet`:
<Restrictions data={RESTRICTIONS.cidrSet} />
<Restrictions data={RESTRICTIONS['v1.13.0'].cidrSet} />
</li>
<li>
`rules.$traffic[].access.$transport.priority`:
<Restrictions data={RESTRICTIONS.priority} />
<Restrictions data={RESTRICTIONS['v1.13.0'].priority} />
</li>
<li>
`rules.$traffic[].access.$transport.ports[].ports_to[]`:
<Restrictions data={RESTRICTIONS.dstPorts} />
<Restrictions data={RESTRICTIONS['v1.13.0'].dstPorts} />
</li>
<li>
`rules.$traffic[].access.$transport.ports[].ports_from[]`:
<Restrictions data={RESTRICTIONS.srcPorts} />
<Restrictions data={RESTRICTIONS['v1.13.0'].srcPorts} />
</li>
<li>
`rules.$traffic[].access.$transport.types[].type[]`:
<Restrictions data={RESTRICTIONS.icmpType} />
<Restrictions data={RESTRICTIONS['v1.13.0'].icmpType} />
</li>
</ul>

Expand Down
Loading