Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
[TAAP-989] removed tic marks from links
Browse files Browse the repository at this point in the history
  • Loading branch information
a-peek4 committed Mar 10, 2023
1 parent f6148a2 commit 1b668fc
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
22 changes: 11 additions & 11 deletions cartographer-conventions/creating-conventions.hbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ For example, adding a Prometheus sidecar to web applications, or adding a `workl

>**Important** For this example, the package `model` defines [resource types](./reference/convention-resources.md).

1. <a id='convention-1'></a> The example `server.go` configures the `ConventionHandler` to ingest the webhook requests from the convention controller. See [PodConventionContext](./reference/pod-convention-context.md). Here the handler must only deal with the existing [`PodTemplateSpec`](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec) and [`ImageConfig`](./reference/image-config.md).
1. <a id='convention-1'></a> The example `server.go` configures the `ConventionHandler` to ingest the webhook requests from the convention controller. See [PodConventionContext](./reference/pod-convention-context.md). Here the handler must only deal with the existing [PodTemplateSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec) and [ImageConfig](./reference/image-config.md).

```go
...
Expand All @@ -171,7 +171,7 @@ For example, adding a Prometheus sidecar to web applications, or adding a `workl
Where:

+ `template` is the predefined `PodTemplateSpec` that the convention edits. For more information about `PodTemplateSpec`, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec).
+ `images` are the [`ImageConfig`](./reference/image-config.md) used as reference to make decisions in the conventions. In this example, the type was created within the `model` package.
+ `images` are the [ImageConfig](./reference/image-config.md) used as reference to make decisions in the conventions. In this example, the type was created within the `model` package.

2. <a id='server-2'></a>The example `server.go` also configures the convention server to listen for requests:

Expand Down Expand Up @@ -200,11 +200,11 @@ For example, adding a Prometheus sidecar to web applications, or adding a `workl

Where:

+ `PORT` is a possible environment variable, for this example, defined in the [`Deployment`](#install-deployment).
+ `PORT` is a possible environment variable, for this example, defined in the [Deployment](#install-deployment).
+ `ServerHandler` is the *handler* function called when any request comes to the server.
+ `NewConventionServer` is the function in charge of configuring and creating the *http webhook* server.
+ `port` is the calculated port of the server to listen for requests. It must match the [`Deployment`](#install-deployment) if the `PORT` variable is not defined in it.
+ The `path` or pattern (default to `/`) is the convention server's default path. If it is changed, it must be changed in the [`ClusterPodConvention`](#install-convention).
+ `port` is the calculated port of the server to listen for requests. It must match the [Deployment](#install-deployment) if the `PORT` variable is not defined in it.
+ The `path` or pattern (default to `/`) is the convention server's default path. If it is changed, it must be changed in the [ClusterPodConvention](#install-convention).

>**Note** The *Server Handler*, `func ConventionHandler(...)`, and the configure or start web server, `func NewConventionServer(...)`, is defined in the convention controller in the `webhook` package, but you can use a custom one.

Expand Down Expand Up @@ -391,13 +391,13 @@ When using environment variables to define whether the convention is applicable,

### <a id='match-crit-img-metadata'></a>Matching criteria by image metadata

For each image contained within the PodTemplateSpec, the convention controller fetches the OCI image metadata and known [`bill of materials (BOMs)`](reference/bom.md), providing it to the convention server as [`ImageConfig`](./reference/image-config.md). This metadata is introspected to make decisions about how to configure the PodTemplateSpec.
For each image contained within the PodTemplateSpec, the convention controller fetches the OCI image metadata and known [bill of materials (BOMs)](reference/bom.md), providing it to the convention server as [ImageConfig](./reference/image-config.md). This metadata is introspected to make decisions about how to configure the PodTemplateSpec.

## <a id='install'></a> Configure and install the convention server

The `server.yaml` defines the Kubernetes components that enable the convention server in the cluster. The next definitions are within the file.

1. <a id='install-namespace'></a>A `namespace` is created for the convention server components and has the required objects to run the server. It's used in the [`ClusterPodConvention`](#install-convention) section to indicate to the controller where the server is.
1. <a id='install-namespace'></a>A `namespace` is created for the convention server components and has the required objects to run the server. It's used in the [ClusterPodConvention](#install-convention) section to indicate to the controller where the server is.

```yaml
...
Expand Down Expand Up @@ -457,7 +457,7 @@ The `server.yaml` defines the Kubernetes components that enable the convention s
...
```

4. <a id='install-deployment'></a>A Kubernetes `Deployment` is created to run the webhook from. The [`Service`](#install-service) uses the container port defined by the `Deployment` to expose the server.
4. <a id='install-deployment'></a>A Kubernetes `Deployment` is created to run the webhook from. The [Service](#install-service) uses the container port defined by the `Deployment` to expose the server.

```yaml
...
Expand Down Expand Up @@ -511,7 +511,7 @@ The `server.yaml` defines the Kubernetes components that enable the convention s
...
```

5. <a id='install-service'></a>A Kubernetes `Service` to expose the convention deployment is created. For this example, the exposed port is the default `443`. If you change the port, the [`ClusterPodConvention`](#install-convention) must be updated.
5. <a id='install-service'></a>A Kubernetes `Service` to expose the convention deployment is created. For this example, the exposed port is the default `443`. If you change the port, the [ClusterPodConvention](#install-convention) must be updated.

```yaml
...
Expand All @@ -534,7 +534,7 @@ The `server.yaml` defines the Kubernetes components that enable the convention s
...
```

6. <a id='install-convention'></a>The [`ClusterPodConvention`](./reference/cluster-pod-convention.md) adds the convention to the cluster to make it available for the convention controller:
6. <a id='install-convention'></a>The [ClusterPodConvention](./reference/cluster-pod-convention.md) adds the convention to the cluster to make it available for the convention controller:
>**Important** The `annotations` block is only needed if you use a self-signed certificate. See the [cert-manager documentation](https://cert-manager.io/docs/).

```yaml
Expand Down Expand Up @@ -568,7 +568,7 @@ To deploy a convention server:
ko apply -f dist/server.yaml
```

+ If a different tool builds the image, the configuration is also be applied using either kubectl or `kapp`, setting the correct image in the [`Deployment`](#install-convention) descriptor.
+ If a different tool builds the image, the configuration is also be applied using either kubectl or `kapp`, setting the correct image in the [Deployment](#install-convention) descriptor.

kubectl

Expand Down
4 changes: 2 additions & 2 deletions cartographer-conventions/reference/image-config.hbs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ImageConfig

The image configuration object holds the name of the image, the [`BOM`](bom.md), and the [OCI image configuration](https://github.com/opencontainers/image-spec/blob/main/config.md) with image metadata from the repository.
The image configuration object holds the name of the image, the [BOM](bom.md), and the [OCI image configuration](https://github.com/opencontainers/image-spec/blob/main/config.md) with image metadata from the repository.

[OCI image configuration](https://github.com/opencontainers/image-spec/blob/main/config.md) contains the metadata from the image repository.

The [`BOM`](bom.md) represents the content of the image and may be zero or more per image.
The [BOM](bom.md) represents the content of the image and may be zero or more per image.

```json
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PodConventionContextSpec

The Pod convention context specification is a wrapper of the [`PodTemplateSpec`](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec) and the [`ImageConfig`](image-config.md) provided in the request body of the server. It represents the original `PodTemplateSpec`. For more information on `PodTemplateSpec`, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec).
The Pod convention context specification is a wrapper of the [PodTemplateSpec](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec) and the [ImageConfig](image-config.md) provided in the request body of the server. It represents the original `PodTemplateSpec`. For more information on `PodTemplateSpec`, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplateSpec).

```console
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Pod convention context is the body of the webhook request and response. The specification is provided by the convention controller and the status is set by the convention server.

The context is a wrapper of the individual object description in an API (TypeMeta), the persistent metadata of a resource ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta)), the [`PodConventionContextSpec`](pod-convention-context-spec.md) and the [`PodConventionContextStatus`](pod-convention-context-status.md).
The context is a wrapper of the individual object description in an API (TypeMeta), the persistent metadata of a resource ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta)), the [PodConventionContextSpec](pod-convention-context-spec.md) and the [PodConventionContextStatus](pod-convention-context-status.md).

In the `PodConventionContext` API resource:

Expand Down Expand Up @@ -53,4 +53,4 @@ The controller is not the source of the metadata, and there is no guarantee that

The `config` field in the image configuration passes through the [OCI Image metadata in GitHub](https://github.com/opencontainers/image-spec/blob/main/config.md) loaded from the registry for the image.

The `boms` field in the image configuration passes through the [`BOM`](bom.md)s of the image. Conventions might parse the BOMs they want to inspect. There is no guarantee that an image contains a BOM or that the BOM is in a certain format.
The `boms` field in the image configuration passes through the [BOM](bom.md)s of the image. Conventions might parse the BOMs they want to inspect. There is no guarantee that an image contains a BOM or that the BOM is in a certain format.
8 changes: 4 additions & 4 deletions scc/ootb-template-reference.hbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ These are used as the `image-provider` resource when the workload parameter `doc

A taskrun.tekton.dev which provides configuration to a Tekton ClusterTask to build an image with kaniko.

This template uses the [`lifecycle: tekton`](https://cartographer.sh/docs/v0.6.0/lifecycle/)
This template uses the [lifecycle: tekton](https://cartographer.sh/docs/v0.6.0/lifecycle/)
flag to create new immutable objects rather than updating the previous object.

### Parameters
Expand Down Expand Up @@ -882,7 +882,7 @@ Deployment and a Kubernetes Service to expose the pods.
For information about the three different types of workloads, see [workload
types](../workloads/workload-types.hbs.md).

For information about the ports parameter, see [`server`-specific Workload
For information about the ports parameter, see [server-specific Workload
parameters](../workloads/server.hbs.md#-server-specific-workload-parameters).

## service-bindings
Expand Down Expand Up @@ -936,7 +936,7 @@ enriches the input with ResourceClaims and ServiceBindings if the workload conta
### More information

For an example, see
[`--service-ref`](../cli-plugins/apps/command-reference/workload_create_update_apply.hbs.md#apply-service-ref)
[--service-ref](../cli-plugins/apps/command-reference/workload_create_update_apply.hbs.md#apply-service-ref)
in the Tanzu CLI documentation.

For an overview of the function, see
Expand Down Expand Up @@ -1917,4 +1917,4 @@ A [kapp App](https://carvel.dev/kapp-controller/docs/v0.41.0/app-overview/).

For details about RBAC and how `kapp-controller` makes use of the ServiceAccount provided through the Deliverable's
`serviceAccount` parameter,
see [`kapp-controller`'s Security Model](https://carvel.dev/kapp-controller/docs/v0.41.0/security-model/).
see [kapp-controller's Security Model](https://carvel.dev/kapp-controller/docs/v0.41.0/security-model/).
2 changes: 1 addition & 1 deletion scst-policy/install-sigstore-stack.hbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ Update the `tap-values` that are used for installation of Tanzu Application Plat
If the internally deployed TUF is used, `tuf_mirror` is `http://tuf.tuf-system.svc`.
If the mirror is hosted elsewhere, provide the correct mirror URL. The default public TUF instance mirror URL is `https://sigstore-tuf-root.storage.googleapis.com`.

The `tuf_root` is the contents of the obtained `root.json` from the `tuf-root` secret in the `tuf-system` namspace. The public TUF instance's [`root.json`](https://sigstore-tuf-root.storage.googleapis.com/root.json).
The `tuf_root` is the contents of the obtained `root.json` from the `tuf-root` secret in the `tuf-system` namspace. The public TUF instance's [root.json](https://sigstore-tuf-root.storage.googleapis.com/root.json).

If Policy Controller was installed through Tanzu Application Profiles, update the values file with:
```yaml
Expand Down

0 comments on commit 1b668fc

Please sign in to comment.