Skip to content

Commit

Permalink
Update paths
Browse files Browse the repository at this point in the history
  • Loading branch information
Erik Veld committed Aug 17, 2023
1 parent 10a0d43 commit 4ce179e
Show file tree
Hide file tree
Showing 35 changed files with 147 additions and 110 deletions.
2 changes: 2 additions & 0 deletions .github/secret_scanning.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
paths-ignore:
- "public/certificates/*"
2 changes: 1 addition & 1 deletion src/components/docs/Navigation.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,4 @@ export function Navigation(props) {
</ul>
</nav>
)
}
}
50 changes: 25 additions & 25 deletions src/config/navigation.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,36 +38,36 @@ export const navigation = [
title: 'Resources',
links: [
{ title: 'Overview', href: '/docs/resources/overview' },
{ title: 'Meta Properties', href: '/docs/resources/meta' },
{ title: 'Resource Functions', href: '/docs/resources/functions' },
{ title: 'Variables', href: '/docs/resources/variables' },
{ title: 'Output', href: '/docs/resources/output' },
{ title: 'Module', href: '/docs/resources/module' },
{ title: 'Meta Properties', href: '/docs/resources/internal/meta' },
{ title: 'Resource Functions', href: '/docs/resources/internal/functions' },
{ title: 'Variables', href: '/docs/resources/internal/variables' },
{ title: 'Output', href: '/docs/resources/internal/output' },
{ title: 'Module', href: '/docs/resources/internal/module' },
{ title: 'Blueprint', href: '/docs/resources/blueprint' },
{ title: 'Book', href: '/docs/resources/book' },
{ title: 'Build', href: '/docs/resources/build' },
{ title: 'Chapter', href: '/docs/resources/chapter' },
{ title: 'Container', href: '/docs/resources/container' },
{ title: 'Book', href: '/docs/resources/docs/book' },
{ title: 'Build', href: '/docs/resources/build/' },
{ title: 'Chapter', href: '/docs/resources/docs/chapter' },
{ title: 'Container', href: '/docs/resources/container/container' },
{ title: 'Copy', href: '/docs/resources/copy' },
{ title: 'Docs', href: '/docs/resources/docs' },
{ title: 'Docs', href: '/docs/resources/docs/docs' },
{ title: 'Helm', href: '/docs/resources/helm' },
{ title: 'Ingress', href: '/docs/resources/ingress' },
{ title: 'Kubernetes Cluster', href: '/docs/resources/kubernetes_cluster' },
{ title: 'Kubernetes Config', href: '/docs/resources/kubernetes_config' },
{ title: 'Leaf Certificate', href: '/docs/resources/certificate_leaf' },
{ title: 'Local Exec', href: '/docs/resources/local_exec' },
{ title: 'Kubernetes Cluster', href: '/docs/resources/k8s/kubernetes_cluster' },
{ title: 'Kubernetes Config', href: '/docs/resources/k8s/kubernetes_config' },
{ title: 'Leaf Certificate', href: '/docs/resources/cert/certificate_leaf' },
{ title: 'Local Exec', href: '/docs/resources/exec/local_exec' },
{ title: 'Network', href: '/docs/resources/network' },
{ title: 'Nomad Cluster', href: '/docs/resources/nomad_cluster' },
{ title: 'Nomad Job', href: '/docs/resources/nomad_job' },
{ title: 'Output', href: '/docs/resources/output' },
{ title: 'Random ID', href: '/docs/resources/random_id' },
{ title: 'Random Number', href: '/docs/resources/random_number' },
{ title: 'Random Password', href: '/docs/resources/random_password' },
{ title: 'Random UUID', href: '/docs/resources/random_uuid' },
{ title: 'Remote Exec', href: '/docs/resources/remote_exec' },
{ title: 'Root Certificate', href: '/docs/resources/certificate_ca' },
{ title: 'Sidecar', href: '/docs/resources/sidecar' },
{ title: 'Task', href: '/docs/resources/task' },
{ title: 'Nomad Cluster', href: '/docs/resources/nomad/nomad_cluster' },
{ title: 'Nomad Job', href: '/docs/resources/nomad/nomad_job' },
{ title: 'Output', href: '/docs/resources/internal/output' },
{ title: 'Random ID', href: '/docs/resources/random/random_id' },
{ title: 'Random Number', href: '/docs/resources/random/random_number' },
{ title: 'Random Password', href: '/docs/resources/random/random_password' },
{ title: 'Random UUID', href: '/docs/resources/random/random_uuid' },
{ title: 'Remote Exec', href: '/docs/resources/random/remote_exec' },
{ title: 'Root Certificate', href: '/docs/resources/cert/certificate_ca' },
{ title: 'Sidecar', href: '/docs/resources/container/sidecar' },
{ title: 'Task', href: '/docs/resources/docs/task' },
{ title: 'Template', href: '/docs/resources/template' },
]
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Blueprint `blueprint`

Expand Down
73 changes: 73 additions & 0 deletions src/pages/docs/resources/build/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import MetaProperties from "../shared/meta.mdx"

# Build `build`

<Intro>
Builds containers and other resources that can be used in blueprints.
</Intro>

## Properties

<Properties>
<Property name="container" type="#container" value="">
Build a container from the given file and context.
Images are cached in the local Docker engine using the following convention.
</Property>
</Properties>

---

## container

```hcl
container {
dockerfile = "Dockerfile"
context = "./src"
}
```

<Properties>
<Property name="dockerfile" type="string" value="Dockerfile">
Docker file to use for the build.
</Property>
<Property name="context" type="string" required="true" value="">
Path to the context for the build.
</Property>
<Property name="tag" type="string" value="">
Tag to tag the resulting image with.
</Property>
<Property name="args" type="map[string]string" value="">
Build args to pass to the build.
</Property>
</Properties>

---

## Examples

```hcl
resource "build" "app" {
container {
dockerfile = "Dockerfile"
context = "./src"
}
}
resource "container" "app" {
image {
name = resource.build.app.image
}
command = ["/bin/app"]
port {
local = 9090
remote = 9090
host = 9090
}
network {
id = resource.network.onprem.id
}
}
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Root Certificate `certificate_ca`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Leaf Certificate `certificate_ca`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import MetaProperties from "./shared/meta.mdx"
import NetworkAttachment from "./shared/network_attachment.mdx"
import Image from "./shared/image.mdx"
import Volume from "./shared/volume.mdx"
import Port from "./shared/port.mdx"
import PortRange from "./shared/port_range.mdx"
import MetaProperties from "../shared/meta.mdx"
import NetworkAttachment from "../shared/network_attachment.mdx"
import Image from "../shared/image.mdx"
import Volume from "../shared/volume.mdx"
import Port from "../shared/port.mdx"
import PortRange from "../shared/port_range.mdx"

# Container `container`

Expand Down Expand Up @@ -160,7 +160,7 @@ The `container` resource allows you to create Docker containers.

---

## health_check
### health_check

A health_check stanza allows the definition of a health check which must pass before
the container is marked as successfully created. There are three different types
Expand Down Expand Up @@ -222,7 +222,7 @@ checks are not executed. The execution order is `http`, `tcp`, `exec.

---

## http_health_check
### http_health_check

A HTTP health check executes a HTTP GET request for the given address and evaluates
the response against the expected `success_codes`. If the reponse matches any of
Expand Down Expand Up @@ -263,7 +263,7 @@ http {
</Property>
</Properties>

## tcp_health_check
### tcp_health_check

A TCP health check attempts to open a connection to the given address. If a
connection can be opened then the check passes.
Expand All @@ -280,7 +280,7 @@ tcp {
</Property>
</Properties>

## exec_health_check
### exec_health_check

Exec health checks allow you to execute a command or script in the current container.
If the command or script receives an exit code `0` the check passes.
Expand Down Expand Up @@ -314,7 +314,7 @@ If the command or script receives an exit code `0` the check passes.
</Property>
</Properties>

## resources
### resources

A resources type allows you to configure the maximum resources which can be consumed.

Expand All @@ -338,7 +338,7 @@ A resources type allows you to configure the maximum resources which can be cons

---

## run_as
### run_as

User and Group configuration to be used when running a container, by default Docker runs commands in the container as root id 0.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import MetaProperties from "./shared/meta.mdx"
import Image from "./shared/image.mdx"
import Volume from "./shared/volume.mdx"
import MetaProperties from "../shared/meta.mdx"
import Image from "../shared/image.mdx"
import Volume from "../shared/volume.mdx"

# Sidecar `sidecar`

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Book `book`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Chapter `chapter`

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Task `task`

Expand Down
38 changes: 0 additions & 38 deletions src/pages/docs/resources/example.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Local Exec

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Helm `helm`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Ingress `ingress`

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Module `module`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Output `output`

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import MetaProperties from "./shared/meta.mdx"
import NetworkAttachment from "./shared/network_attachment.mdx"
import Image from "./shared/image.mdx"
import Volume from "./shared/volume.mdx"
import Port from "./shared/port.mdx"
import PortRange from "./shared/port_range.mdx"
import MetaProperties from "../shared/meta.mdx"
import NetworkAttachment from "../shared/network_attachment.mdx"
import Image from "../shared/image.mdx"
import Volume from "../shared/volume.mdx"
import Port from "../shared/port.mdx"
import PortRange from "../shared/port_range.mdx"

# Kubernetes Cluster `k8s_cluster`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Example `example`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import MetaProperties from "./shared/meta.mdx"
import NetworkAttachment from "./shared/network_attachment.mdx"
import Image from "./shared/image.mdx"
import Volume from "./shared/volume.mdx"
import Port from "./shared/port.mdx"
import PortRange from "./shared/port_range.mdx"
import MetaProperties from "../shared/meta.mdx"
import NetworkAttachment from "../shared/network_attachment.mdx"
import Image from "../shared/image.mdx"
import Volume from "../shared/volume.mdx"
import Port from "../shared/port.mdx"
import PortRange from "../shared/port_range.mdx"

# Nomad Cluster `nomad_cluster`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Nomad Job `nomad_job`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Random Creature `random_creature`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Random ID `random_id`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MetaProperties from "./shared/meta.mdx"
import MetaProperties from "../shared/meta.mdx"

# Random Number `random_number`

Expand Down
Loading

0 comments on commit 4ce179e

Please sign in to comment.