Skip to content

Commit

Permalink
Merge branch 'master' into doc/agent-service-rn-v1.0.61
Browse files Browse the repository at this point in the history
  • Loading branch information
danielGz authored Aug 29, 2023
2 parents 5251254 + fb62413 commit 2983a34
Show file tree
Hide file tree
Showing 117 changed files with 3,589 additions and 1,694 deletions.
42 changes: 29 additions & 13 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,41 @@ googleAnalytics = 'G-W14B82N2D2'

#disableKinds = ["taxonomy", "taxonomyTerm"]

# Highlighting config
# Highlighting config (copied from the docsy example site, tag v0.7.1)
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"
pygmentsStyle = "dracula"

[markup]
[markup.goldmark]
[markup.goldmark.parser.attribute]
block = true
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "dracula"
# these are defaults https://gohugo.io/getting-started/configuration-markup/#highlight
anchorLineNos = false
codeFences = true
hl_Lines = ''
hl_inline = false
lineAnchors = ''
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true
noHl = false
tabWidth = 4
guessSyntax = true
# Set guessSyntax to true if you want your chosen highlight style used for code blocks without a specified language

# Docsy is now a Go module; need to map theme dirs to local dirs
# 16 Aug 2023 When I remove the module.imports.mounts entries, compilation breaks with a lot of "not found" - can't find shortcodes or refs
[module]
proxy = "direct"

Expand Down Expand Up @@ -106,17 +131,12 @@ anchor = "smart"
[languages]
[languages.en]
#comment out title as it messes with the new logo
#title = "Armory Docs"
title = "Armory Docs"
description = "Unlocking Innovation by Making Software Delivery Continuous, Scalable, and Safe"
languageName ="English"
# Weight used for sorting.
weight = 1

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true

[[menu.main]]
name = "CD-as-a-Service"
weight = 2
Expand Down Expand Up @@ -156,7 +176,6 @@ weight = 1

[params]
# See codenew shortcode
githubWebsiteRaw = "raw.githubusercontent.com/armory/docs"
deploy-engine-plugin-version = "0.16.8"
armory-version = "2.30.x"
#used in air-gapped
Expand All @@ -167,7 +186,7 @@ postgresql-version="10+"
#used in the Operator docs
armory-version-exact = "2.30.0"
halyard-armory-version = "1.12.1"
kubesvc-version="1.0.59"
kubesvc-version="1.0.62"
operator-extended-crd-version = "v1alpha2"
operator-oss-crd-version = "v1alpha2"
opa-server-version = "0.28.0"
Expand Down Expand Up @@ -220,9 +239,6 @@ offlineSearch = true
offlineSearchMaxResults = 50
offlineSearchSummaryLength = 200

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = true

# Armory Agent plugin versions
[params.kubesvc-plugin]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ The following script generates these files in the `services` directory:
- Certificate and key files for each Golang services (`terraformer.crt` and `terraformer.key`, ...)
- a `tls-passwords` file containing all the passwords. You can store as-is in a bucket.


{{< prism lang="shell" line-numbers="true" >}}
```shell
#!/bin/bash -e

# You can change it to a different method
Expand Down Expand Up @@ -172,12 +171,12 @@ EOF
echo "${svc}: ${password}" >> services/tls-passwords
done
{{< /prism >}}
```
## Troubleshooting
You may encounter the following error if the version of Java you are using to generate the certificates is not the same version that Armory Continuous Deployment is using:
{{< prism lang="shell" >}}
```bash
java.io.IOException: Integrity check failed: java.security.NoSuchAlgorithmException: Algorithm HmacPBESHA256 not available
{{< /prism >}}
```
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following configuration example shows how to configure Echo to send data to

Add the <b>rest</b> block to the <b>spec.spinnakerConfig.profiles.echo</b> section of your Operator manifest.

{{< prism lang="yaml" >}}
```yaml
apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
Expand All @@ -43,7 +43,7 @@ spec:
Authorization: "<TOKEN>"
template: '{"event":{{event}} }'
insecure: true
{{< /prism >}}
```
* `SERVICE_URL`: the FQDN of the service; for example `https://splunk.armory.io`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You have two options for installing the Observability plugin:

The following example adds the Observability Plugin configuration for all services to the `spinnaker-local.yml` file and enables Prometheus:

{{< prism lang="yaml" >}}
```yaml
# These lines are spring-boot configuration to allow access to the metrics
# endpoints. This plugin adds the "aop-prometheus" endpoint on the
# "<service>:<port>/aop-prometheus" path.
Expand All @@ -54,6 +54,6 @@ spinnaker:
repositories:
armory-observability-plugin-releases:
url: https://raw.githubusercontent.com/armory-plugins/armory-observability-plugin-releases/master/repositories.json
{{< /prism >}}
```
You can find more options for management endpoints and the plugin in the [plugin's README](https://github.com/armory-plugins/armory-observability-plugin).
Loading

0 comments on commit 2983a34

Please sign in to comment.