linkerd / linkerd/website

In documentation for Helm chart replace command for Identity.Issuer.CrtExpiry

Open
#516 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

## Bug Report

### What is the issue?

https://linkerd.io/2/tasks/install-helm/#helm-install-procedure
and https://linkerd.io/2/tasks/generate-certificates/

```bash
# set expiry date one year from now, in Mac:
exp=$(date -v+8760H +"%Y-%m-%dT%H:%M:%SZ")
# in Linux:
exp=$(date -d '+8760 hour' +"%Y-%m-%dT%H:%M:%SZ")
```

The command does not look perfect, because with each call it generates a new value and does not correspond to the expiration date in CrtPEM as it is required in `values.yaml`:

```yaml
# must match the expiry date in CrtPEM
CrtExpiry:
```

### Possible solution

I suggest to replace it with something like this:

```bash
date -d"$(cat issuer.crt | openssl x509 -noout -enddate | sed 's/notAfter=//')" +"%Y-%m-%dT%H:%M:%SZ"
2020-09-05T09:11:25Z

# which is equal to
cat issuer.crt | openssl x509 -noout -enddate | sed 's/notAfter=//'
Sep 5 09:11:25 2020 GMT

# versus
date -d '+8760 hour' +"%Y-%m-%dT%H:%M:%SZ
2020-09-05T11:03:18Z
```

Not sure about the syntax for OSX.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Helm install procedure and certificate-generation pages linked in the issue, then compare the documented expiry command with the CrtPEM requirement in values.yaml. Verify the proposed certificate-derived command on Linux and determine the corresponding OSX syntax. Done means both pages show a command that derives CrtExpiry from issuer.crt and remains consistent with the certificate expiry.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.