coreos/tectonic-docs

Tectonic documentation - https://coreos.com/tectonic/docs/latest/

tectonic-docs

Tectonic documentation Markdown source. Published at https://coreos.com/tectonic/docs/latest/.

Open source: Apache license. Edit and improve by following the contributing guidelines in accordance with CoreOS documentation style.

tectonic-docs's Issues

Links with anchors aren't parsed properly

Some reference links aren't parsed correctly into A tags even though they're defined correctly at the bottom of the page. I think this is the case for any reference links defined after one containing an anchor.

As an example, In logging-destination.md fluentd-match is linked properly (in the first paragraph) but any references defined after it (fluentd-plugin, iam-credentials, etc) aren't parsed and render as raw text in the page.

https://github.com/coreos/tectonic-docs/blame/1.7.5-tectonic.1/Documentation/admin/logging-destination.md#L241

Docker file does not include fluentd geo plugin

On kubernetes, the plugins that are installed is:

fluent-plugin-elasticsearch (1.9.5)
fluent-plugin-kubernetes_metadata_filter (0.28.0)
fluent-plugin-prometheus (0.3.0)
fluent-plugin-record-reformer (0.9.1)
fluent-plugin-rewrite-tag-filter (1.5.6)
fluent-plugin-secure-forward (0.4.5)
fluent-plugin-systemd (0.0.8)
fluentd (0.12.39)

Similar to elk example, be useful to install the geoip and maxcity database for nginx logs to map ip to geo co-ordinates:

See:
https://github.com/kayrus/elk-kubernetes/blob/master/docker/fluentd/install.sh

Azure documentation needs to specify allowed locations

Tried to deploy Tectonic on westus2 location by setting tectonic_azure_location and it failed with a error related to fault-domains.
When location changed to eastus, the deployment succeeded.

Error applying plan:

3 error(s) occurred:

* module.etcd.azurerm_availability_set.etcd: 1 error(s) occurred:

* azurerm_availability_set.etcd: compute.AvailabilitySetsClient#CreateOrUpdate: Failure responding to request: StatusCode=400 -- Original Error: autorest/azure: Service returned an error. Status=400 Code="InvalidParameter" Message="The specified fault domain count 3 must fall in the range 1 to 2."
* module.workers.azurerm_availability_set.tectonic_workers: 1 error(s) occurred:

* azurerm_availability_set.tectonic_workers: compute.AvailabilitySetsClient#CreateOrUpdate: Failure responding to request: StatusCode=400 -- Original Error: autorest/azure: Service returned an error. Status=400 Code="InvalidParameter" Message="The specified fault domain count 3 must fall in the range 1 to 2."
* module.masters.azurerm_availability_set.tectonic_masters: 1 error(s) occurred:

* azurerm_availability_set.tectonic_masters: compute.AvailabilitySetsClient#CreateOrUpdate: Failure responding to request: StatusCode=400 -- Original Error: autorest/azure: Service returned an error. Status=400 Code="InvalidParameter" Message="The specified fault domain count 3 must fall in the range 1 to 2."

Terraform does not automatically rollback in the face of errors.
Instead, your Terraform state file has been partially updated with
any resources that successfully completed. Please address the error
above and apply again to incrementally change your infrastructure.

Azure documentation is not correct regarding terraform

I've been trying to install Tectonic on Azure and it's not working if I follow the instructions.
I've used both MacOS and Ubuntu with identical results and I'm using the proper terreform

The following step is failing:

jolcese@jolcese-osx:~/src/kubernetes/tectonic$ which terraform
/Users/jolcese/src/kubernetes/tectonic/tectonic-installer/darwin/terraform
jolcese@jolcese-osx:~/src/kubernetes/tectonic$ terraform init platforms/azure
Initializing configuration from: "platforms/azure"...
Error copying source: The destination path contains Terraform configuration files. The init command
with a SOURCE parameter can only be used on a directory without existing
Terraform files.

Please resolve this issue and try again.
jolcese@jolcese-osx:~/src/kubernetes/tectonic$

But this one works:

jolcese@jolcese-osx:~/src/kubernetes/tectonic$ cd platforms/azure/
jolcese@jolcese-osx:~/src/kubernetes/tectonic/platforms/azure$
jolcese@jolcese-osx:~/src/kubernetes/tectonic/platforms/azure$ terraform init
Downloading modules (if any)...
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/resource-group
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/vnet
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/etcd
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/master-as
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/worker-as
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/dns/azure
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/bootkube
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/tectonic
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/net/flannel-vxlan
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/net/calico-network-policy
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/net/ignition
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/udev-rules
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/net/ignition
Get: file:///Users/jolcese/src/kubernetes/tectonic/modules/azure/udev-rules

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your environment. If you forget, other
commands will detect it and remind you to do so if necessary.
jolcese@jolcese-osx:~/src/kubernetes/tectonic/platforms/azure$

And then, the plan \ apply shall be executed from:

jolcese@jolcese-osx:~/src/kubernetes/tectonic/platforms/azure$ terraform plan -var-file=../../build/${CLUSTER}/terraform.tfvars
Refreshing Terraform state in-memory prior to plan...
The refreshed state will be used to calculate this plan, but will not be
persisted to local or remote state storage.

data.template_file.tectonic_rkt: Refreshing state...
data.ignition_systemd_unit.locksmithd: Refreshing state...
data.ignition_user.core: Refreshing state...
data.template_file.tectonic: Refreshing state...
data.ignition_user.core: Refreshing state...
data.ignition_file.azure_udev_rules: Refreshing state...
data.template_file.kubelet-worker: Refreshing state...
data.template_file.bootkube_service: Refreshing state...
data.template_file.tectonic_service: Refreshing state...
data.ignition_systemd_unit.docker: Refreshing state...
data.ignition_file.kubelet_env: Refreshing state...
...
...
...
Plan: 144 to add, 0 to change, 0 to destroy.
jolcese@jolcese-osx:~/src/kubernetes/tectonic/platforms/azure$

the heredoc syntax for specifying CERTS doesn't seem to work

Looking at the bare metal installer variables listing, I attempted to use the HEREDOC syntax for specifying these file contents inline.

It doesn't seem to function as you would expect, as it interpolates any file with a / in it, as a suspected comment. Additionally, if you omit the " it also complains about the heredoc syntax. The only way I was able to get the file contents to read inline is to take the squashed output from the tectonic-installer, where it combines everything into an escaped single-line w/ encoded newlines.

Could someone take a look at this and see about updating the docs to have a proper solution for end-users trying to plug in matchbox certs?

404 on logo.svg in example app deployment

Following https://github.com/coreos/tectonic-docs/blob/master/Documentation/tutorials/sandbox/first-app.md.

"logo.svg" relative path results to 404 , so Cookie image is not visible in example app.

It is accessible through simple_deployment/logo.svg but the app is not ready for it.

ingress.kubernetes.io/add-base-url: "true"
does not help.

I guess the problem is pretty generic.

Any suggestions how to fix the serving of resources with relative path?

Wrong RewriteRule for index.html pages

Hi,

The Tectonic on AWS tutorial page is available under this link: https://coreos.com/tectonic/docs/latest/tutorials/aws/index.html

The same page should also be available under this link: https://coreos.com/tectonic/docs/latest/tutorials/aws/. The current configuration is wrong. I get ERR_TOO_MANY_REDIRECTS as an error.
Same error applies to all folders in the tectonic docs.

Button links in documentation not rendered correctly

Hi,

All buttons in the documentation tutorials have a link defined as follow:

<a href="install.md" class="btn btn-primary btn-lg">Let's Get Started</a>

The rendered html link is not valid (HTTP 404). The link is not converted to the html page link (See https://github.com/coreos/tectonic-docs/blob/master/Documentation/tutorials/sandbox/index.md and https://coreos.com/tectonic/docs/latest/tutorials/sandbox/index.html).

We could replace install.md with install.html. I did not find any other solution to fix this. Please let me know if you have any.