Skip to content
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

Package update #261

Merged
merged 3 commits into from
Oct 1, 2024
Merged

Package update #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbc0aee
aws-secrets and aws-acm vaults
jfallows Sep 13, 2024
06feeae
update page structure and add links
vordimous Sep 24, 2024
053c764
fix: update packages and remove workarounds
vordimous Oct 1, 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
25 changes: 15 additions & 10 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,25 @@
"check-schema": "node ./.check-schema"
},
"devDependencies": {
"@vuepress/bundler-vite": "2.0.0-rc.13",
"@vuepress/plugin-catalog": "2.0.0-rc.36",
"@vuepress/plugin-docsearch": "2.0.0-rc.36",
"@vuepress/plugin-google-analytics": "2.0.0-rc.34",
"@vuepress/plugin-redirect": "2.0.0-rc.36",
"@vuepress/plugin-register-components": "2.0.0-rc.34",
"@vuepress/plugin-shiki": "2.0.0-rc.36",
"@vuepress/bundler-vite": "2.0.0-rc.17",
"@vuepress/plugin-catalog": "2.0.0-rc.52",
"@vuepress/plugin-docsearch": "2.0.0-rc.52",
"@vuepress/plugin-google-analytics": "2.0.0-rc.52",
"@vuepress/plugin-markdown-hint": "2.0.0-rc.52",
"@vuepress/plugin-markdown-image": "2.0.0-rc.52",
"@vuepress/plugin-markdown-tab": "2.0.0-rc.52",
"@vuepress/plugin-redirect": "2.0.0-rc.52",
"@vuepress/plugin-register-components": "2.0.0-rc.52",
"@vuepress/plugin-shiki": "2.0.0-rc.52",
"link-checker": "^1.4.2",
"markdownlint-cli2": "^0.8.1",
"mathjax-full": "^3.2.2",
"mermaid": "^10.9.1",
"vue": "^3.4.29",
"vuepress": "2.0.0-rc.13",
"vuepress-theme-hope": "2.0.0-rc.49"
"sass-embedded": "^1.79.4",
"sass-embedded-darwin-arm64": "^1.79.4",
"vue": "^3.5.10",
"vuepress": "2.0.0-rc.17",
"vuepress-theme-hope": "2.0.0-rc.58"
},
"pnpm": {
"overrides": {
Expand Down
2,463 changes: 1,588 additions & 875 deletions pnpm-lock.yaml
View file
Open in desktop

Large diffs are not rendered by default.

94 changes: 18 additions & 76 deletions src/.vuepress/styles/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,38 @@
// Dark theme settings
html[data-theme="dark"] #app {
--code-highlight-bg-color: #203e36;
--border-color: #0e5c49;
--code-border-color: #333;
--tab-nav-bg-color: var(--code-tabs-nav-bg-color);
--tab-nav-hover-color: var(--code-tabs-nav-hover-color);
--tab-bg-color: #161b25;
--tab-nav-text-color: var(--code-tabs-nav-text-color);
--note-bg-color: var(--bg-color);
--info-bg-color: var(--bg-color);
--tip-bg-color: #001c00;
--warning-bg-color: #1d1500;
--caution-bg-color: #340c0d;
.vp-sidebar {
scrollbar-color: #274b41 #333;
}
.vp-footer img.logo {
content: url("/footer-logo-white.webp");
}
}

// Light theme settings
html[data-theme="light"] #app {
--code-highlight-bg-color: #a9d4c9;
--border-color: #55877a;
--code-bg-color: #e4e6e5;
--code-border-color: #eee;
--tab-nav-bg-color: var(--code-tabs-nav-bg-color);
--tab-nav-hover-color: var(--code-tabs-nav-hover-color);
--tab-bg-color: #e6f0f9;
--tab-nav-text-color: var(--code-tabs-nav-text-color);
--info-bg-color: var(--info-bg-color);

.vp-sidebar {
scrollbar-color: #a9d4c9 #e4e6e5;
}
.vp-footer img.logo {
content: url("/footer-logo.webp");
}
}

// make bash code blocks have $ prefix
pre.language-bash {
padding-left: 0.8rem;
code:before {
content: "$ ";
font-weight: bold;
margin-left: -1rem;
div.language-bash pre {
padding-left: 0.8rem;
code:before {
content: "$ ";
font-weight: bold;
margin-left: -1rem;
}
}
div.language-output {
button.vp-copy-code-button {
display: none;
}
}

Expand Down Expand Up @@ -73,12 +66,6 @@ p {
hyphens: none !important;
}

// don't adjust image boarders
.theme-hope-content figure img {
overflow: auto;
border-radius: unset;
}

// Increase H tag headers font weight
h1,
h2,
Expand Down Expand Up @@ -132,7 +119,6 @@ h6 {
}

.vp-sidebar {
scrollbar-color: var(--code-highlight-bg-color) var(--code-bg-color);
.vp-sidebar-links {
margin-left: 0rem;
.vp-sidebar-group > .vp-sidebar-header {
Expand Down Expand Up @@ -207,50 +193,6 @@ sup {
}
}

// Fix VPCard spacing
.vp-card {
max-width: 330px;
}

// Style text output in a code block
@layer {
div.language-output {
border-radius: 0px !important;
border-inline-start: 0.2rem solid var(--code-border-color);

code {
padding: 0.25rem 0 0.25rem 1rem !important;
span {
color: #666 !important;
font-size: 1rem;
overflow-wrap: break-word;
}
}

button.vp-copy-code-button {
display: none;
}
}
}

// Fix code tabs border radius, remove with https://github.com/vuepress-theme-hope/vuepress-theme-hope/issues/4235
.vp-code-tabs {
div[class*="language-"].line-numbers-mode::after {
border-radius: 0;
border-bottom-left-radius: 6px;
}
div[class*="language-"] {
pre {
border-radius: 0;
border-bottom-left-radius: 6px;
border-bottom-right-radius: 6px;
}
}
}
pre.shiki {
border-radius: 0 6px 6px 0 !important;
}

// === ICONS ===
.aky-zilla-plus {
&::after {
Expand Down
20 changes: 14 additions & 6 deletions src/.vuepress/theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,7 @@ export default hopeTheme({
align: true,
attrs: true,
chart: false,
codetabs: true,
component: false,
hint: true,
figure: true,
imgLazyload: true,
include: {
resolvePath: (file) => {
path.resolve(file);
Expand All @@ -102,9 +98,21 @@ export default hopeTheme({
},
mark: true,
mermaid: true,
tabs: true,
gfm: true,
linkify: false,
},
markdownTab: {
codeTabs: true,
tabs: true,
},
markdownImage: {
figure: true,
lazyload: true,
mark: true,
size: true,
},
markdownHint: {
hint: true,
alert: true,
},
},
});
14 changes: 7 additions & 7 deletions src/reference/config/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Namespace name.

### bindings

> `object` as map of named[`binding`](./bindings/) properties
> `object` as map of named [`binding`](../../concepts/bindings.md) properties

Each configured `binding` represents a step in the pipeline as data streams are decoded, translated or encoded according to a specific protocol `type`.

Expand All @@ -52,7 +52,7 @@ Unconditional `exit` binding acting as a default if none of the conditional rout

### guards

> `object` as map of named[`guard`](./guards/) properties
> `object` as map of named [`guard`](../../concepts/guards.md) properties

Each configured `guard` represents a security checkpoint for one or more bindings based on a specific implementation `type`.

Expand All @@ -62,23 +62,23 @@ Associated roles can be enforced during routing by only following routes `guarde

### vaults

> `object` as map of named[`vault`](./vaults/) properties
> `object` as map of named [`vault`](../../concepts/vaults.md) properties

Each configured `vault` represents a container for digital keys and certificates based on a specific implementation `type`.

Vaults can be used by specific protocol bindings, such as `tls`, to negotiate shared encryption keys.

### catalogs

> `object` as map of named[`catalog`](./catalogs/) properties
> `object` as map of named [`catalog`](../../concepts/catalogs.md) properties

Each configured `catalog` represent a catalog of schemas of various format based on a specific implementation `type`.

Catalogs can be used by specific protocol bindings to enforce validation.

### telemetry

> `object` of [`telemetry`](./telemetry/) properties
> `object` of [`telemetry`](../../concepts/telemetry.md) properties

```yaml
telemetry:
Expand All @@ -98,12 +98,12 @@ Default attributes to optionally include when exporting metrics.

#### exporters

> `object` as map of named[`exporter`](./telemetry/exporters/) properties
> `object` as map of named [`exporter`](../../concepts/telemetry.md#exporters) properties

Map of named exporters.

#### metrics

> `array` of `string` of named [`metrics`](./telemetry/metrics/)
> `array` of `string` of named [`metrics`](../../concepts/telemetry.md#metrics)

Array of named metrics.
23 changes: 23 additions & 0 deletions src/reference/config/vaults/aws-acm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
redirectFrom: /reference/config/vaults/vault-aws.html
shortTitle: aws-acm
icon: aky-zilla-plus
category:
- Vault
---

# aws-acm Vault

A Zilla runtime aws-acm vault that enables remote access of AWS services from an EC2 instance.

This is typically combined with a [tls](../bindings/tls/README.md) binding `vault` property, referencing resources such as `certificates` by Amazon Resource Names (ARNs).

Note: this requires AWS Nitro Enclaves for ACM to be enabled on the instance where Zilla Plus is running.

[Available in <ZillaPlus/>](https://www.aklivity.io/products/zilla-plus)
{.zilla-plus-badge .hint-container .info}

```yaml {2}
server:
type: aws-acm
```
20 changes: 20 additions & 0 deletions src/reference/config/vaults/aws-secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
shortTitle: aws-secrets
icon: aky-zilla-plus
category:
- Vault
---

# aws-secrets Vault

A Zilla runtime aws-secrets vault that enables remote access of AWS services from an EC2 instance.

This is typically combined with a [tls](../bindings/tls/README.md) binding `vault` property, referencing resources such as `secrets` by Amazon Resource Names (ARNs).

[Available in <ZillaPlus/>](https://www.aklivity.io/products/zilla-plus)
{.zilla-plus-badge .hint-container .info}

```yaml {2}
server:
type: aws-secrets
```
74 changes: 0 additions & 74 deletions src/reference/config/vaults/aws.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion src/solutions/how-tos/amazon-msk/secure-public-access/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ The <ZillaPlus/> proxy relies on TLS so we need to create a file called `client.

@tab client.properties

```toml:no-line-numbers
```text:no-line-numbers
security.protocol=SSL
ssl.truststore.location=/tmp/kafka.client.truststore.jks
```
Expand Down
Loading
Loading