Skip to content

Commit 6cbc02f

Browse files
Update docs
1 parent 6f6b6ca commit 6cbc02f

4 files changed

Lines changed: 54 additions & 254 deletions

File tree

docs/hub/concepts/management-models.md

Lines changed: 17 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -5,144 +5,55 @@ description: Decide when to use the Hub itself, joined CCM instances, Agents, or
55

66
# Choose a Management Model
77

8-
The main design choice is where certificate requests, renewals, and deployment should run.
8+
Choosing a management model means deciding where certificate requests, renewals, and deployment should happen. Some teams want everything to run from the Hub. Others need the work to run close to the systems that use the certificate. The best option depends on network access, deployment needs, and how centralized you want day-to-day operations to be. You can use a mixed approach according to your own organizational preferences.
99

1010
## Execution Location
1111

12-
Your main options are:
13-
14-
- on the Hub server itself
15-
- on a joined *Certify Certificate Manager* instance
16-
- on a joined *Certify Management Agent* instance
17-
- on a managed instance that subscribes to a Hub-managed certificate
18-
- in another ACME client that uses the Hub only for shared services
12+
The Hub supports several ways to manage and operate certificate renewals. You can renew certificate directly on the Hub, on a joined *Certify Certificate Manager* (CCM) instance, on a joined *Certify Management Agent*, on a managed instance that subscribes to a Hub-managed certificate, or in another ACME client that uses the Hub for shared services. Many environments end up using more than one of these models at the same time.
1913

2014
## Hub Execution
2115

22-
Best fit:
23-
24-
- the Hub server can reach the target systems and any deployment endpoints it needs
25-
- you want a central web-only operating model
26-
- you only need one or a few execution locations
27-
- local deployment from the Hub is acceptable
28-
29-
Common cases:
16+
The Hub requests the certificate, completes validation, and handles deployment from the Hub server itself. This works well when the Hub can already reach the systems it needs to manage and when local deployment from the Hub is acceptable. It is often a good fit for centralized environments, internal services managed from one Windows host, DNS-based validation, or early proof-of-concept work.
3017

31-
- internal services managed from one Windows host
32-
- DNS-based validation where the Hub can complete the order directly
33-
- simple initial deployments and proof-of-concept environments
34-
35-
Less suitable when:
36-
37-
- HTTP validation must happen on many remote web servers
38-
- deployment requires platform-local access that the Hub host does not have
39-
- the work needs to stay with the machine that actually owns the certificate
18+
This model is less suitable when work needs to happen on many remote systems or when deployment depends on access that only the target machine has. For example, if HTTP validation must happen on several web servers or deployment relies on platform-local tools, running everything from the Hub can become challenging.
4019

4120
## CCM Execution
4221

43-
Best fit:
44-
45-
- you already use *Certify Certificate Manager* on Windows servers
46-
- IIS or other Windows-specific deployment remains local to those servers
47-
- you want centralized administration without moving the execution point
22+
CCM execution is a strong choice when you already use *Certify Certificate Manager* on Windows servers. In this model, the Hub gives you centralized administration, but the actual renewal and deployment work still runs on the joined CCM instance. That means IIS deployment and other Windows-specific tasks stay local to the server that owns the workload.
4823

49-
Common cases:
50-
51-
- existing Windows certificate automation is already working
52-
- you need to manage many Windows servers from one UI
53-
- deployment uses local Windows features, shares, services, or PowerShell-based automation
24+
This approach works well when you already have Windows automation in place and do not want to move the execution point. It also fits environments where deployment depends on local Windows features such as IIS, CCS shares, services, or PowerShell-based automation.
5425

5526
## Agent Execution
5627

57-
Best fit:
58-
59-
- the target systems are Linux, macOS, container hosts, or headless environments
60-
- renewals and deployment should happen near the workload
61-
- you want the Hub to control the configuration but not run the work locally
62-
63-
Common cases:
28+
Agent execution is intended for systems such as Linux, macOS, container hosts, or other headless environments. The Hub still manages the configuration, but the joined Management Agent runs renewals and deployment near the workload. This is useful when you want centralized control without forcing the Hub server to do all the work itself.
6429

65-
- Apache, nginx, and other non-Windows stacks
66-
- distributed platform teams
67-
- external client monitoring on non-Windows hosts
30+
It is commonly used for Apache, nginx, and other non-Windows stacks. It also fits distributed platform teams and environments where external client monitoring needs to run on non-Windows hosts.
6831

6932
## Certificate Subscription Model
7033

71-
Best fit:
72-
73-
- one system should renew the certificate
74-
- another managed instance should only consume and deploy it
75-
- CA accounts and challenge configuration should remain centralized
76-
77-
Common cases:
78-
79-
- a Hub-managed certificate is reused by one or more managed instances
80-
- remote instances need the latest certificate but should not run local renewal
34+
The certificate subscription model separates renewal from consumption. One system (the hub or another managed instance) renews the certificate, while another managed instance only receives and deploys the latest result. This is useful when you want CA accounts, ACME challenge settings, and renewal logic to stay centralized, but still need the certificate on other machines.
8135

82-
This model depends on the managed instance having the **Cert Consumer** role, usually filtered by tag so only the intended certificates are visible.
36+
In practice, this allows a Hub-managed certificate to be reused by one or more managed instances without each instance running its own renewal. The managed instance normally needs the **Cert Consumer** role, and access is usually filtered by tag so only the intended certificates are visible.
8337

8438
## External ACME Clients
8539

86-
Best fit:
40+
You can also keep using other ACME clients and use the Hub for shared services. This is helpful when you already have an existing client you do not want to replace, but you still want centralized DNS challenge handling or a managed ACME endpoint.
8741

88-
- you already have another ACME client that you do not want to replace
89-
- you need centralized DNS challenge handling
90-
- you want the Hub to act as a managed ACME endpoint for compatible clients
42+
There are two main patterns. With **Managed Challenges**, the client still orders the certificate, but the Hub performs DNS updates on its behalf. With **Managed ACME Service**, the client talks to the Hub's ACME endpoint, and the Hub proxies the order to the real ACME CA.
9143

92-
Service patterns:
44+
## How to Choose
9345

94-
- **Managed Challenges**: the client still orders the certificate, but the Hub performs DNS updates on its behalf
95-
- **Managed ACME Service**: the client talks to the Hub's ACME endpoint, and the Hub proxies the order to the real ACME CA
46+
If the Hub server already has the access it needs and you want the fewest moving parts, Hub execution is usually the simplest choice. If the workload is Windows-based and deployment should stay on the Windows server that owns it, CCM is usually the better fit. If the workload is on Linux, macOS, or another headless platform, an Agent is usually the right option.
9647

97-
## Selection Criteria
98-
99-
### Hub
100-
101-
- central execution is simpler than distributing execution
102-
- local access from the Hub host is enough
103-
- you want the smallest number of moving parts
104-
105-
### CCM
106-
107-
- the workload is Windows-based
108-
- deployment should stay with the Windows server that owns the workload
109-
- you want to preserve existing CCM operating patterns
110-
111-
### Agent
112-
113-
- the workload is not Windows-based
114-
- you need local execution on Linux or macOS
115-
- you need headless operation
116-
117-
### Certificate Subscription
118-
119-
- renewal should stay on the source system
120-
- the target instance only needs the resulting certificate
121-
- certificate access should be controlled through managed instance roles and tags
122-
123-
### Managed Challenge or Managed ACME
124-
125-
- you want to reduce distribution of DNS API credentials
126-
- you need to support other ACME clients
127-
- the Hub should provide centralized authorization or API-based certificate services
48+
If renewal should happen in one place but the resulting certificate needs to be used somewhere else, the subscription model is often the cleanest approach. If you need to support other ACME clients or reduce how widely DNS API credentials are distributed, Managed Challenges or Managed ACME Service can be a better match.
12849

12950
## Mixed Deployments
13051

131-
Many environments use more than one model.
132-
133-
Examples:
134-
135-
- The Hub runs some internal certificates directly, while remote CCM instances handle IIS-bound sites.
136-
- Agents renew certificates on Linux hosts, while the Hub provides managed DNS challenges centrally.
137-
- One Hub-managed certificate is renewed centrally and consumed by selected managed instances through subscriptions.
138-
- A third-party ACME client uses the Hub ACME service, while other systems are joined directly.
52+
Many real environments use a mix of models. For example, the Hub might handle a few internal certificates directly while remote CCM instances manage IIS-bound sites. Agents may renew certificates on Linux hosts while the Hub provides managed DNS challenges for the wider environment. In another setup, a certificate may be renewed centrally in the Hub and then consumed by selected managed instances through subscriptions. It is also possible to combine joined instances with third-party ACME clients that use the Hub's shared services.
13953

14054
## Deployment Sequence
14155

142-
1. Start with one target instance and one working certificate path.
143-
2. Confirm where renewals and deployment should run.
144-
3. Add joined instances where local execution is required.
145-
4. Add managed challenges or managed ACME only when shared services are needed.
56+
A practical way to begin is to start with one target instance and make sure one certificate path works from end to end. Once that is working, confirm where renewal and deployment should run in your environment. After that, add joined instances only where local execution is required, and introduce Managed Challenges or Managed ACME only when shared services solve a real problem.
14657

14758
## Read Next
14859

docs/hub/guides/certificate-authorities-and-credentials.md

Lines changed: 12 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -5,113 +5,51 @@ description: Configure CA accounts, failover, staging, and reusable stored crede
55

66
# Certificate Authorities and Stored Credentials
77

8-
Most certificate workflows depend on two settings areas:
9-
10-
- **Certificate Authorities**
11-
- **Stored Credentials**
12-
13-
Both are available under **Settings** and are usually managed per target instance.
8+
Most certificate workflows depend on two settings areas: **Certificate Authorities** and **Stored Credentials**. Both are available under **Settings** and are usually managed per target instance. The certificate authority (ACME) account is what the Hub uses to request a certificate, and the stored credential is what it uses when it needs a reusable secret such as a DNS API key or password.
149

1510
## Certificate Authorities
1611

17-
The Hub uses CA accounts to order certificates from ACME-enabled certificate authorities.
18-
19-
The settings page distinguishes between:
20-
21-
- **ACME CA Accounts**
22-
- the broader list of known **Certificate Authorities**
23-
24-
The important item is the account configured on the selected target instance.
12+
The Hub uses CA accounts to order certificates from ACME-enabled certificate authorities. On the settings page, you will usually see both **ACME CA Accounts** and the broader list of known **Certificate Authorities**. The important detail is the account configured on the selected target instance, because that is the account the Hub will actually use when it places a request.
2513

2614
## CA Accounts
2715

28-
A CA account represents the registration that the target instance uses when talking to a specific CA.
29-
30-
You need at least one suitable account before the Hub can request certificates.
31-
32-
Typical account choices include:
33-
34-
- Let's Encrypt
35-
- Google Trust Services or Google Cloud ACME
36-
- private or local ACME services where supported
37-
- other compatible public or private ACME providers
16+
A CA account is the registration a target instance uses when talking to a specific certificate authority. You need at least one suitable account before the Hub can request any certificates. Common choices include Let's Encrypt, Google Trust Services or Google Cloud ACME, private or local ACME services where supported, and other compatible public or private ACME providers.
3817

3918
## Production and Staging
4019

41-
Use **Production** accounts for real trusted certificates.
42-
43-
Use **Staging** accounts when you need to:
44-
45-
- test automation safely
46-
- verify new authorization paths
47-
- avoid production rate limits during early setup
20+
Use **Production** accounts for real trusted certificates. Optionally use **Staging** accounts when you want to test automation safely, verify a new authorization path, or avoid production rate limits during early setup. If you choose staging, make sure the matching staging option is also selected in the certificate settings so the request uses the correct environment from start to finish.
4821

49-
If you use staging, use the matching staging option in the certificate settings as well.
22+
Use of Staging accounts is generally rare in practice, more users just work with one production ACME account per instance.
5023

5124
## Automatic CA Failover
5225

53-
General settings exposes **Enable Automatic CA Failover** and a **Preferred CA** selector.
54-
55-
Use this only if:
56-
57-
- you have valid compatible CA accounts configured
58-
- you understand which certificates can be issued by the alternative CA
59-
- your environment can tolerate CA switching when the preferred provider fails
60-
61-
For simpler environments, keep one CA path first and add failover later.
26+
General settings includes **Enable Automatic CA Failover** and a **Preferred CA** selector. This can be useful, but only when you already have valid and compatible CA accounts configured, understand which certificates the alternative CA can issue, and are comfortable with the environment switching providers when the preferred one fails. In simpler environments, it is usually better to keep one CA path working first and add failover later.
6227

6328
## Local ACME and Managed ACME
6429

65-
The UI may also show the local Hub ACME service alongside public CAs. Treat that as a separate service model, not as a replacement for normal public CA accounts.
66-
67-
Use the managed ACME service when you want the Hub to provide an ACME-facing endpoint to other clients. Use normal ACME CA accounts when the Hub or target instance is ordering the certificate directly.
30+
The UI may also show the local Hub ACME service alongside public certificate authorities. Treat this as a separate service model, not as a replacement for a normal public CA account. Use the managed ACME service when you want the Hub to act as an ACME-facing endpoint for other clients. Use standard ACME CA accounts when the Hub or the target instance is ordering the certificate directly.
6831

6932
## Stored Credentials
7033

71-
Stored credentials are reusable secrets such as:
72-
73-
- DNS API keys
74-
- passwords
75-
- token pairs or other provider credentials
76-
77-
They are used by features such as:
78-
79-
- DNS authorization
80-
- managed challenges
81-
- deployment tasks
82-
- instance-specific integrations
34+
Stored credentials are reusable secrets such as DNS API keys, passwords, token pairs, or other provider credentials. They are used by features like DNS authorization, managed challenges, deployment tasks, and other instance-specific integrations. Instead of entering the same secret again and again, you store it once and reference it where needed.
8335

8436
## Credential Reuse
8537

86-
Reuse one stored credential when:
87-
88-
- the same DNS zone or provider account is used by many certificates
89-
- the same deployment integration needs the same credential repeatedly
90-
- you want one controlled credential instead of duplicating secrets in many definitions
91-
92-
Avoid over-sharing when:
93-
94-
- different teams or tenants should be isolated
95-
- the credential scope is broader than required
96-
- you need clear ownership and revocation paths
38+
Reusing a stored credential makes sense when the same DNS zone or provider account is used by many certificates, when the same deployment integration needs the same secret repeatedly, or when you want one controlled credential instead of copying secrets into many certificate definitions. At the same time, avoid sharing credentials too broadly. If different teams or tenants should stay separate, if the credential has wider access than necessary, or if you need clear ownership and revocation paths, create separate credentials instead.
9739

9840
## Recommendations
9941

100-
- Create CA accounts on the target instance that will perform the work.
101-
- Keep staging and production clearly separated.
102-
- Reuse stored credentials deliberately, not automatically.
103-
- Name credentials and CA accounts so their purpose is obvious later.
104-
- Add failover only after the primary path is stable.
42+
Create CA accounts on the target instance that will perform the work, and keep staging and production clearly separate. Reuse stored credentials deliberately rather than automatically, and name both credentials and CA accounts so their purpose is still obvious later. If you plan to use failover, add it only after the primary certificate path is stable and well understood.
10543

10644
## Common Errors
10745

10846
### There is no matching ACME account
10947

110-
This usually means the selected target instance does not have a compatible CA account configured for the certificate settings.
48+
This usually means the selected target instance does not have a compatible CA account configured for the certificate settings. In most cases, the fix is to check which target instance is doing the work and then confirm that it has the expected CA account available.
11149

11250
### DNS validation cannot proceed
11351

114-
This often means the required stored credential is missing, scoped incorrectly, or configured on a different target instance than the one performing the request.
52+
This often means the required stored credential is missing, scoped incorrectly, or configured on a different target instance than the one performing the request. It can also mean the credential exists but does not give the level of DNS access needed for the selected zone or provider.
11553

11654
## Read Next
11755

0 commit comments

Comments
 (0)