Skip to content

Commit

Permalink
Updating console URL in docs (#1746)
Browse files Browse the repository at this point in the history
## Type of change
<!-- Please be sure to add the appropriate label to your PR. -->
We recently started redirecting requests to `console.enforce.dev` to
`console.chainguard.dev`. This PR updates the any cases where
`console.enforce.dev` comes up to point to the new URL.

### What should this PR do?
<!-- Does this PR resolve an issue? Please include a reference to it.
-->
resolves chainguard-dev/internal#4073

### Why are we making this change?
<!-- What larger problem does this PR address? -->
Part of keeping our docs current and accurate

### What are the acceptance criteria? 
<!-- What should be happening for this PR to be accepted? Please list
criteria. -->
<!-- Do any stakeholders need to be tagged in this review? If so, please
add them. -->
Links should work!

### How should this PR be tested?
<!-- What should your reviewer do to test this PR? Please list steps.
-->
Feel free to test the links yourself but a visual scan ought to do.

Note that two of the custom IDP docs (Azure AD + PingID) include
screenshots that point to the old URL. Additionally, Azure AD has been
rebranded, so that whole doc will likely need to be udpated.

I tried logging into both of these platforms to see about grabbing new
screenshots but unfortunately I'm locked out of both accounts (I think
the free trials I signed up for have expired and now I'm persona non
grata). I will keep exploring my options there but for now I'm saying
those updates are beyond the scope of this.

Signed-off-by: Mark Drake <mark@chainguard.dev>
  • Loading branch information
SharpRake authored Aug 6, 2024
1 parent 233e456 commit ebd8d79
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Save your configuration by clicking the **Register** button.

Next, you can optionally set additional branding for the application by selecting the **Branding and properties** tab.

There, you can set additional metadata for the application, including a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.enforce.dev/logo512.png). The console homepage is [console.enforce.dev](https://console.enforce.dev), and our terms of service and private statements can be found at [chainguard.dev/terms-of-service](https://www.chainguard.dev/terms-of-service) and [chainguard.dev/privacy-notice](https://www.chainguard.dev/privacy-notice), respectively.
There, you can set additional metadata for the application, including a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.chainguard.dev/logo512.png). The console homepage is [console.chainguard.dev](https://console.chainguard.dev), and our terms of service and private statements can be found at [chainguard.dev/terms-of-service](https://www.chainguard.dev/terms-of-service) and [chainguard.dev/privacy-notice](https://www.chainguard.dev/privacy-notice), respectively.

![Screenshot of the Branding & properties screen with the following settings: Name is set to "Chainguard"; Logo shows the sample Inky logo uploaded; Home page URL is set to "https://console.enforce.dev"; Terms of service URL is set to "https://www.chainguard.dev/terms-of-service"; and the Privacy statement URL is set to "https://www.chainguard.dev/privacy-notice".](aad-branding.png)
![Screenshot of the Branding & properties screen with the following settings: Name is set to "Chainguard"; Logo shows the sample Inky logo uploaded; Home page URL is set to "https://console.chainguard.dev"; Terms of service URL is set to "https://www.chainguard.dev/terms-of-service"; and the Privacy statement URL is set to "https://www.chainguard.dev/privacy-notice".](aad-branding.png)

Finally, navigate to the **Certificates & secrets** tab to create a client secret to authenticate the Chainguard platform to Azure Active Directory. Select **New client secret** to add a client secret. In the resulting modal window, add a description and set an expiration date.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ If you aren't using one of these identity providers, you can complete the follow

For a generic OIDC-compatible identity provider, start by creating an OIDC application. If possible, set as much metadata as possible for the application so that your users can identify this application as the Chainguard platform. The following assets and details can be helpful to include in metadata.

* The Console homepage is [https://console.enforce.dev/](https://console.enforce.dev)
* The Console homepage is [console.chainguard.dev/](https://console.chainguard.dev)
* Our terms of service can be found at [chainguard.dev/terms-of-service](https://www.chainguard.dev/terms-of-service)
* Our terms of use can be found at [chainguard.dev/terms-of-use](https://www.chainguard.dev/terms-of-use)
* Our privacy policy is located at [chainguard.dev/privacy-notice](https://www.chainguard.dev/privacy-notice)
* You can also add a Chainguard logo icon here to help your users visually identify this integration. The icon from the [Chainguard Console](https://console.enforce.dev/logo512.png) will be suitable for most platforms.
* You can also add a Chainguard logo icon here to help your users visually identify this integration. The icon from the [Chainguard Console](https://console.chainguard.dev/logo512.png) will be suitable for most platforms.

Next, configure your OIDC application as follows:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Select **OIDC - OpenID Connect** as the sign-in method and **Web Application** a
Next, in the **General Settings** window, configure the application as follows.

* **App integration name**: Enter a descriptive name (like "Chainguard") here.
* **Logo**: You can optionally add a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.enforce.dev/logo512.png).
* **Logo**: You can optionally add a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.chainguard.dev/logo512.png).
* **Grant type**: Ensure that the grant type is set to **Authorization Code** only.

> **Warning**: DO NOT select other grant types as this may compromise your security.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ To integrate the Ping identity provider with the Chainguard platform, [sign on t
Configure the application as follows:

* **Application Name**: Set a name and option description (such as "Chainguard") to ensure users recognize this application is for authentication to the Chainguard platform.
* **Icon**: You can optionally add a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.enforce.dev/logo512.png).
* **Icon**: You can optionally add a Chainguard logo icon here to help your users visually identify this integration. If you'd like, you can use the icon from the [Chainguard Console](https://console.chainguard.dev/logo512.png).
* **Application Type**: Select **OIDC Web App**.

![Screenshot showing the Add Application modal window with the following settings in place: Application Name is set to "Chainguard"; Description reads "Build it right, Build it safe, Build it fast, https://console.enforce.dev"; the example Inky icon has been uploaded to the Icon field; and the Application Type is set to "OIDC Web App."](ping-2-add-app.png)
![Screenshot showing the Add Application modal window with the following settings in place: Application Name is set to "Chainguard"; Description reads "Build it right, Build it safe, Build it fast, https://console.chainguard.dev"; the example Inky icon has been uploaded to the Icon field; and the Application Type is set to "OIDC Web App."](ping-2-add-app.png)

After setting these details, click the **Save** button.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ images: []
weight: 015
---

Both [`chainctl`](/chainguard/chainctl/) and the [Chainguard Console](https://console.enforce.dev/) are useful tools for interacting with Chainguard. However, there may be times that you want to hand off certain administrative tasks to an automation system, like Buildkite or GitHub Actions.
Both [`chainctl`](/chainguard/chainctl/) and the [Chainguard Console](https://console.chainguard.dev/) are useful tools for interacting with Chainguard. However, there may be times that you want to hand off certain administrative tasks to an automation system, like Buildkite or GitHub Actions.

In such cases, you can create a Chainguard identity for these systems to assume, allowing them to perform certain tasks within a specific scope. You can restrict access to an identity so that only workflows that present tokens matching a specific issuer and subject can assume it. Likewise, assumable identities can be tied to certain roles — like `viewer`, `owner`, or `editor` — letting you place strict limits on what a given identity is allowed to do.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ After pressing `ENTER`, the command will complete.
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
```

Following this, any members of your GitHub team for whom you've created role-bindings will be able to view the resources associated with the Chainguard organization you specified. To do so, they need to log in to the Chainguard platform, either by logging into the [Chainguard Console](https://console.enforce.dev/) or with the following command.
Following this, any members of your GitHub team for whom you've created role-bindings will be able to view the resources associated with the Chainguard organization you specified. To do so, they need to log in to the Chainguard platform, either by logging into the [Chainguard Console](https://console.chainguard.dev/) or with the following command.

```sh
chainctl auth login
Expand Down
15 changes: 7 additions & 8 deletions content/chainguard/administration/manage-chainctl-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,13 @@ Flags:
-h, --help help for config
Global Flags:
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file.
--console string The url of the Chainguard platform Console. (default "https://console.enforce.dev")
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
--timestamp-authority string The url of the Chainguard Timestamp Authority endpoint. (default "https://tsa.enforce.dev")
-v, --v int Set the log verbosity level.
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
Use "chainctl config [command] --help" for more information about a command.
```
Expand Down
1 change: 0 additions & 1 deletion content/chainguard/administration/network-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ This table lists the DNS hostnames, associated ports, and protocols that will ne
| ----------------------- | ---- | -------- | ----------------------------------------------- |
| cgr.dev | 443 | HTTPS | Main image registry |
| console.chainguard.dev | 443 | HTTPS | Chainguard dashboard |
| console.enforce.dev | 443 | HTTPS | Chainguard dashboard |
| console-api.enforce.dev | 443 | HTTPS | Registry API endpoint |
| enforce.dev | 443 | HTTPS | Registry authentication |
| dl.enforce.dev | 443 | HTTPS | `chainctl` downloads |
Expand Down
4 changes: 2 additions & 2 deletions content/chainguard/chainguard-images/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The main features of Chainguard Images include:
- [Verifiable signatures](/chainguard/chainguard-images/working-with-images/retrieve-image-sboms/) provided by [Sigstore](/open-source/sigstore/cosign/an-introduction-to-cosign/)
- Reproducible builds with Cosign and apko ([read more about reproducibility](https://www.chainguard.dev/unchained/reproducing-chainguards-reproducible-image-builds))

Chainguard Images are available from the [Chainguard Registry](/chainguard/chainguard-registry/overview/) and can be pulled from `cgr.dev`. You can review images files [on GitHub](https://github.com/chainguard-images) and can find complete lists of available Chainguard Images in the [public Images Directory](https://images.chainguard.dev/) or within the [Chainguard Console](https://console.enforce.dev/).
Chainguard Images are available from the [Chainguard Registry](/chainguard/chainguard-registry/overview/) and can be pulled from `cgr.dev`. You can review images files [on GitHub](https://github.com/chainguard-images) and can find complete lists of available Chainguard Images in the [public Images Directory](https://images.chainguard.dev/) or within the [Chainguard Console](https://console.chainguard.dev/).


## Why Minimal Container Images
Expand Down Expand Up @@ -59,7 +59,7 @@ Production Images are enterprise-ready images that come with patch SLAs and feat

You can access Images directly from the [Chainguard Registry](/chainguard/chainguard-registry/overview/). The Chainguard Registry provides public access to all public Chainguard Images, and provides customer access for Production Images after logging in and authenticating.

You can find complete lists of all the Developer and Production Images available to you in [the Chainguard Console](https://console.enforce.dev/?utm=docs). After logging in you will be able to find all the current Developer Images in the **Public images** tab. If you've selected an appropriate Organization in the drop-down menu above the left hand navigation, you can find your organization's Production Images in the **Organization images** tab.
You can find complete lists of all the Developer and Production Images available to you in [the Chainguard Console](https://console.chainguard.dev/?utm=docs). After logging in you will be able to find all the current Developer Images in the **Public images** tab. If you've selected an appropriate Organization in the drop-down menu above the left hand navigation, you can find your organization's Production Images in the **Organization images** tab.


## Comparing Images
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There are hundreds of Chainguard Images available for use. To help users explore

## Accessing the Images Directory

This guide is framed around the Images Directory found in the Chainguard Console. The Console is accessible to anyone, including users who aren't Chainguard customers. To access the Console, you'll first need to [create an account and sign in](https://console.enforce.dev/auth/login).
This guide is framed around the Images Directory found in the Chainguard Console. The Console is accessible to anyone, including users who aren't Chainguard customers. To access the Console, you'll first need to [create an account and sign in](https://console.chainguard.dev/auth/login).

If you're not ready to create a Chainguard account, you can also follow along with the public [Chainguard Images Directory](https://images.chainguard.dev/). As of this writing, there are some differences between the two directories, but both should provide a similar experience for users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The other extra argument is the `--predicate-type` flag, required to specify whi

## Image SBOMs in the Chainguard Console

You can also find Image SBOMs in the [Chainguard Console](https://console.enforce.dev). After signing in to the Console and clicking either the **Public images** or, if available, **Organization images** you'll be presented with a list of images. Clicking on any of these will take you to the image's landing page. There, you can click on the [**SBOM** tab](/chainguard/chainguard-images/images-directory/#sboms-tab) to find and download the SBOM for the given Image.
You can also find Image SBOMs in the [Chainguard Console](https://console.chainguard.dev). After signing in to the Console and clicking either the **Public images** or, if available, **Organization images** you'll be presented with a list of images. Clicking on any of these will take you to the image's landing page. There, you can click on the [**SBOM** tab](/chainguard/chainguard-images/images-directory/#sboms-tab) to find and download the SBOM for the given Image.

The following example shows the **SBOM** tab for the `postgres` Image.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ As of August 16, 2023, all other tags for Chainguard Images are unavailable with

## Signing Up

You can register a Chainguard account through our [sign up form](https://console.enforce.dev/auth/login?utm_source=docs). This will create your account and a [Chainguard IAM organization](/chainguard/administration/iam-organizations/overview-of-chainguard-iam-model/). If you already have an account, you can log in through the [login page](https://console.enforce.dev/auth/login?utm_source=docs).
You can register a Chainguard account through our [sign up form](https://console.chainguard.dev/auth/login?utm_source=docs). This will create your account and a [Chainguard IAM organization](/chainguard/administration/iam-organizations/overview-of-chainguard-iam-model/). If you already have an account, you can log in through the [login page](https://console.chainguard.dev/auth/login?utm_source=docs).

For more details on signing in, you can review our [sign in guidance](/chainguard/administration/iam-organizations/how-to-manage-iam-organizations-in-chainguard/#logging-in). If your organization is interested in (or already using) custom identity providers like Okta, you can read [how to authenticate to Chainguard with custom identity providers](/chainguard/administration/custom-idps/custom-idps/).

Expand Down Expand Up @@ -80,7 +80,7 @@ chainctl iam identity delete <identity UUID>

### Managing Pull Tokens in the Chainguard Console

You can also create and view pull tokens in the [Chainguard Console](https://console.enforce.dev/).
You can also create and view pull tokens in the [Chainguard Console](https://console.chainguard.dev/).

After navigating to the Console, click on **Settings** in the left-hand navigation menu. From the **Settings** pane, click on **Pull tokens**. There, you'll be presented with a table listing of all the active pull tokens for your selected organization.

Expand Down

0 comments on commit ebd8d79

Please sign in to comment.