Skip to content

Commit 60cf43c

Browse files
tronghnjhrv
andauthored
update links to documentation (#217)
Co-authored-by: Johnny Horvi <[email protected]>
1 parent 1859671 commit 60cf43c

File tree

5 files changed

+24
-26
lines changed

5 files changed

+24
-26
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The final step in the build pipeline sends an API request to NAIS deploy to depl
1212
## How it works
1313
1. The teams pipeline use `deploy` to send a deployment request to `hookd`.
1414
1. `hookd` receives the deployment request, verifies its integrity and authenticity, and passes the message on to `deployd` via gRPC.
15-
1. `deployd` receives the message from `hookd`, assumes the identity of the deploying team, and applies your _Kubernetes resources_ into the specified [cluster](https://doc.nais.io/clusters).
15+
1. `deployd` receives the message from `hookd`, assumes the identity of the deploying team, and applies your _Kubernetes resources_ into the specified [cluster](https://doc.nais.io/workloads/reference/environments).
1616
1. If the Kubernetes resources contained any _Application_ or _Deployment_ resources, `deployd` will wait until these are rolled out successfully, or a timeout occurs.
1717

1818
Any fatal error will short-circuit the process with a `error` or `failure` status posted back to Github. A successful deployment will result in a `success` status.
1919
Intermediary statuses will be posted, indicating the current state of the deployment.
2020

2121
## Usage
22-
The usage documentation has been moved to [NAIS platform documentation](https://doc.nais.io/deployment).
22+
The usage documentation has been moved to [NAIS platform documentation](https://doc.nais.io/build).
2323

2424
### Deploy API
2525
_We strongly recommend that teams use the `deploy` cli to deploy, rather than posting directly to `hookd`._
@@ -50,16 +50,16 @@ to track the status of your deployment.
5050
}
5151
```
5252

53-
| Field | Type | Description |
54-
|-------|------|-------------|
55-
| resources | list[object] | Array of Kubernetes resources |
56-
| team | string | Team tag |
57-
| cluster | string | Kubernetes cluster, see [NAIS clusters](https://doc.nais.io/clusters) |
58-
| environment | string | GitHub environment |
59-
| owner | string | GitHub repository owner |
60-
| repository | string | GitHub repository name |
61-
| ref | string | GitHub commit hash or tag |
62-
| timestamp | int64 | Current Unix timestamp |
53+
| Field | Type | Description |
54+
|-------|------|-----------------------------------------------------------------------------------------------|
55+
| resources | list[object] | Array of Kubernetes resources |
56+
| team | string | Team tag |
57+
| cluster | string | Kubernetes cluster, see [NAIS clusters](https://doc.nais.io/workloads/reference/environments) |
58+
| environment | string | GitHub environment |
59+
| owner | string | GitHub repository owner |
60+
| repository | string | GitHub repository name |
61+
| ref | string | GitHub commit hash or tag |
62+
| timestamp | int64 | Current Unix timestamp |
6363

6464
Additionally, the header `X-NAIS-Signature` must contain a keyed-hash message authentication code (HMAC).
6565
The code can be derived by hashing the request body using the SHA256 algorithm together with your team's NAIS Deploy API key.

actions/deploy/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Usage
44

5-
See the [NAIS documentation](https://doc.nais.io/how-to-guides/github-action/).
5+
See the [NAIS documentation](https://doc.nais.io/build/how-to/build-and-deploy).
66

77
## Configuration options
88

@@ -28,4 +28,3 @@ The available configuration options for the NAIS deploy GitHub action.
2828

2929
Note that `OWNER` and `REPOSITORY` corresponds to the two parts of a full repository identifier.
3030
If that name is `navikt/myapplication`, those two variables should be set to `navikt` and `myapplication`, respectively.
31-

actions/deploy/entrypoint.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ fi
4545
if [ -z "$APIKEY" ]; then
4646
if [ -z "$ACTIONS_ID_TOKEN_REQUEST_TOKEN" ] || [ -z "$ACTIONS_ID_TOKEN_REQUEST_URL" ]; then
4747
echo "Missing id-token permissions. This must be set either globally in the workflow, or for the specific job performing the deploy."
48-
echo "For more info see https://doc.nais.io/how-to-guides/github-action and/or https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs"
48+
echo "For more info see https://doc.nais.io/build/how-to/build-and-deploy and/or https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs"
4949

5050
exit 1
5151
fi

pkg/deployd/deployd/deployd_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ var tests = []testSpec{
157157
timeout: 2 * time.Second,
158158
endStatus: &pb.DeploymentStatus{
159159
State: pb.DeploymentState_failure,
160-
Message: "nais.io/v1alpha1, Kind=Application, Namespace=aura, Name=myapplication-unknown-fields: creating resource: strict decoding error:\n| ⚠️ unknown field \"spec.nestedField\"\n| ⚠️ unknown field \"spec.unknownField\"\n| The fields might be misspelled, incorrectly indented, or unsupported. Fields are case sensitive.\n| Please verify your resource against the reference documentation at https://doc.nais.io/reference/application-spec/ (total of 1 errors)",
160+
Message: "nais.io/v1alpha1, Kind=Application, Namespace=aura, Name=myapplication-unknown-fields: creating resource: strict decoding error:\n| ⚠️ unknown field \"spec.nestedField\"\n| ⚠️ unknown field \"spec.unknownField\"\n| The fields might be misspelled, incorrectly indented, or unsupported. Fields are case sensitive.\n| Please verify your resource against the reference documentation at https://doc.nais.io/workloads/application/reference/application-spec/ (total of 1 errors)",
161161
},
162162
deployedResources: nil,
163163
},
@@ -168,7 +168,7 @@ var tests = []testSpec{
168168
timeout: 2 * time.Second,
169169
endStatus: &pb.DeploymentStatus{
170170
State: pb.DeploymentState_failure,
171-
Message: "nais.io/v1alpha1, Kind=Application, Namespace=aura, Name=myapplication: updating resource: strict decoding error:\n| ⚠️ unknown field \"spec.nestedField\"\n| ⚠️ unknown field \"spec.unknownField\"\n| The fields might be misspelled, incorrectly indented, or unsupported. Fields are case sensitive.\n| Please verify your resource against the reference documentation at https://doc.nais.io/reference/application-spec/ (total of 1 errors)",
171+
Message: "nais.io/v1alpha1, Kind=Application, Namespace=aura, Name=myapplication: updating resource: strict decoding error:\n| ⚠️ unknown field \"spec.nestedField\"\n| ⚠️ unknown field \"spec.unknownField\"\n| The fields might be misspelled, incorrectly indented, or unsupported. Fields are case sensitive.\n| Please verify your resource against the reference documentation at https://doc.nais.io/workloads/application/reference/application-spec/ (total of 1 errors)",
172172
},
173173
deployedResources: nil,
174174
},

pkg/deployd/strategy/deploy.go

+8-9
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,14 @@ func transformStrictDecodingError(resource unstructured.Unstructured, err error)
6969
}
7070

7171
docs := map[string]string{
72-
"aiven.io/v1alpha1, Kind=OpenSearch": "https://doc.nais.io/how-to-guides/persistence/opensearch/create/",
73-
"aiven.io/v1alpha1, Kind=Redis": "https://doc.nais.io/how-to-guides/persistence/redis/",
74-
"aiven.io/v1alpha1, Kind=ServiceIntegration": "https://doc.nais.io/how-to-guides/persistence/opensearch/create/#serviceintegration",
75-
"kafka.nais.io/v1, Kind=Topic": "https://doc.nais.io/how-to-guides/persistence/kafka/create/",
76-
"krakend.nais.io/v1, Kind=ApiEndpoints": "https://doc.nais.io/explanation/auth/apigateway/",
77-
"monitoring.coreos.com/v1, Kind=PrometheusRule": "https://doc.nais.io/how-to-guides/observability/alerts/prometheus-basic/",
78-
"nais.io/v1alpha1, Kind=Application": "https://doc.nais.io/reference/application-spec/",
79-
"nais.io/v1, Kind=Naisjob": "https://doc.nais.io/reference/naisjob-spec/",
80-
"unleash.nais.io/v1, Kind=ApiToken": "https://doc.nais.io/explanation/feature-toggling/?h=#creating-a-new-api-token",
72+
"aiven.io/v1alpha1, Kind=OpenSearch": "https://doc.nais.io/persistence/opensearch/how-to/create/",
73+
"aiven.io/v1alpha1, Kind=Redis": "https://doc.nais.io/persistence/redis/",
74+
"aiven.io/v1alpha1, Kind=ServiceIntegration": "https://doc.nais.io/persistence/opensearch/how-to/create/#serviceintegration",
75+
"kafka.nais.io/v1, Kind=Topic": "https://doc.nais.io/persistence/kafka/how-to/create/",
76+
"monitoring.coreos.com/v1, Kind=PrometheusRule": "https://doc.nais.io/observability/alerting/reference/prometheusrule/",
77+
"nais.io/v1alpha1, Kind=Application": "https://doc.nais.io/workloads/application/reference/application-spec/",
78+
"nais.io/v1, Kind=Naisjob": "https://doc.nais.io/workloads/job/reference/naisjob-spec/",
79+
"unleash.nais.io/v1, Kind=ApiToken": "https://doc.nais.io/services/feature-toggling/?h=#creating-a-new-api-token",
8180
}
8281

8382
s := &strings.Builder{}

0 commit comments

Comments
 (0)