Skip to content

Commit f16eb13

Browse files
kylecarbskylecarbs
authored
chore: update multiple git providers docs (#10017)
* chore: update multiple git providers docs * Improve var name * Fix fmt
1 parent eeab33b commit f16eb13

File tree

7 files changed

+37
-37
lines changed

7 files changed

+37
-37
lines changed

‎codersdk/deployment.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const (
4242
FeatureTemplateRBAC FeatureName = "template_rbac"
4343
FeatureUserRoleManagement FeatureName = "user_role_management"
4444
FeatureHighAvailability FeatureName = "high_availability"
45-
FeatureMultipleGitAuth FeatureName = "multiple_git_auth"
45+
FeatureMultipleExternalAuth FeatureName = "multiple_external_auth"
4646
FeatureExternalProvisionerDaemons FeatureName = "external_provisioner_daemons"
4747
FeatureAppearance FeatureName = "appearance"
4848
FeatureAdvancedTemplateScheduling FeatureName = "advanced_template_scheduling"
@@ -60,7 +60,7 @@ var FeatureNames = []FeatureName{
6060
FeatureSCIM,
6161
FeatureTemplateRBAC,
6262
FeatureHighAvailability,
63-
FeatureMultipleGitAuth,
63+
FeatureMultipleExternalAuth,
6464
FeatureExternalProvisionerDaemons,
6565
FeatureAppearance,
6666
FeatureAdvancedTemplateScheduling,
@@ -89,7 +89,7 @@ func (n FeatureName) Humanize() string {
8989
// This method may disappear at any time.
9090
func (n FeatureName) AlwaysEnable() bool {
9191
return map[FeatureName]bool{
92-
FeatureMultipleGitAuth: true,
92+
FeatureMultipleExternalAuth: true,
9393
FeatureExternalProvisionerDaemons: true,
9494
FeatureAppearance: true,
9595
FeatureWorkspaceBatchActions: true,

‎docs/admin/external-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Optionally, you can request custom scopes:
111111
CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
112112
```
113113

114-
### Multiple git providers (enterprise)
114+
### Multiple External Providers (enterprise)
115115

116116
Multiple providers are an Enterprise feature. [Learn more](../enterprise.md).
117117

‎docs/enterprise.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ Coder is free to use and includes some features that are only accessible with a
44
paid license. [Contact Sales](https://coder.com/contact) for pricing or
55
[get a free trial](https://coder.com/trial).
66

7-
| Category | Feature | Open Source | Enterprise |
8-
| --------------- | ------------------------------------------------------------------------------------ | :---------: | :--------: |
9-
| Support | Email, Phone, Prioritization | ❌ | ✅ |
10-
| Scale | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
11-
| Scale | [Multiple Git Providers](./admin/git-providers.md#multiple-git-providers-enterprise) | ❌ | ✅ |
12-
| Scale | [Isolated Terraform Runners](./admin/provisioners.md) | ❌ | ✅ |
13-
| Scale | [Workspace Proxies](./admin/workspace-proxies.md) | ❌ | ✅ |
14-
| Governance | [Audit Logging](./admin/audit-logs.md) | ❌ | ✅ |
15-
| Governance | [Browser Only Connections](./networking/#browser-only-connections-enterprise) | ❌ | ✅ |
16-
| Governance | [Groups & Template RBAC](./admin/rbac.md) | ❌ | ✅ |
17-
| Cost Control | [Quotas](./admin/quotas.md) | ❌ | ✅ |
18-
| Cost Control | [Max Workspace Autostop](./templates/#configure-max-workspace-autostop) | ❌ | ✅ |
19-
| User Management | [Groups](./admin/groups.md) | ❌ | ✅ |
20-
| User Management | [Group & role sync](./admin/auth.md#group-sync-enterprise) | ❌ | ✅ |
21-
| User Management | [SCIM](./admin/auth.md#scim) | ❌ | ✅ |
7+
| Category | Feature | Open Source | Enterprise |
8+
| --------------- | --------------------------------------------------------------------------------------------------- | :---------: | :--------: |
9+
| Support | Email, Phone, Prioritization | ❌ | ✅ |
10+
| Scale | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
11+
| Scale | [Multiple External Auth Providers](./admin/external-auth.md#multiple-external-providers-enterprise) | ❌ | ✅ |
12+
| Scale | [Isolated Terraform Runners](./admin/provisioners.md) | ❌ | ✅ |
13+
| Scale | [Workspace Proxies](./admin/workspace-proxies.md) | ❌ | ✅ |
14+
| Governance | [Audit Logging](./admin/audit-logs.md) | ❌ | ✅ |
15+
| Governance | [Browser Only Connections](./networking/#browser-only-connections-enterprise) | ❌ | ✅ |
16+
| Governance | [Groups & Template RBAC](./admin/rbac.md) | ❌ | ✅ |
17+
| Cost Control | [Quotas](./admin/quotas.md) | ❌ | ✅ |
18+
| Cost Control | [Max Workspace Autostop](./templates/#configure-max-workspace-autostop) | ❌ | ✅ |
19+
| User Management | [Groups](./admin/groups.md) | ❌ | ✅ |
20+
| User Management | [Group & role sync](./admin/auth.md#group-sync-enterprise) | ❌ | ✅ |
21+
| User Management | [SCIM](./admin/auth.md#scim) | ❌ | ✅ |
2222

2323
## Adding your license key
2424

‎enterprise/coderd/coderd.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ func (api *API) updateEntitlements(ctx context.Context) error {
465465
codersdk.FeatureBrowserOnly: api.BrowserOnly,
466466
codersdk.FeatureSCIM: len(api.SCIMAPIKey) != 0,
467467
codersdk.FeatureHighAvailability: api.DERPServerRelayAddress != "",
468-
codersdk.FeatureMultipleGitAuth: len(api.ExternalAuthConfigs) > 1,
468+
codersdk.FeatureMultipleExternalAuth: len(api.ExternalAuthConfigs) > 1,
469469
codersdk.FeatureTemplateRBAC: api.RBAC,
470470
codersdk.FeatureExternalTokenEncryption: len(api.ExternalTokenEncryption) > 0,
471471
codersdk.FeatureExternalProvisionerDaemons: true,

‎enterprise/coderd/license/license.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func Entitlements(
2323
db database.Store,
2424
logger slog.Logger,
2525
replicaCount int,
26-
gitAuthCount int,
26+
externalAuthCount int,
2727
keys map[string]ed25519.PublicKey,
2828
enablements map[codersdk.FeatureName]bool,
2929
) (codersdk.Entitlements, error) {
@@ -161,8 +161,8 @@ func Entitlements(
161161
if featureName == codersdk.FeatureHighAvailability {
162162
continue
163163
}
164-
// Multiple Git auth has it's own warnings based on the number configured!
165-
if featureName == codersdk.FeatureMultipleGitAuth {
164+
// External Auth Providers auth has it's own warnings based on the number configured!
165+
if featureName == codersdk.FeatureMultipleExternalAuth {
166166
continue
167167
}
168168
feature := entitlements.Features[featureName]
@@ -200,23 +200,23 @@ func Entitlements(
200200
}
201201
}
202202

203-
if gitAuthCount > 1 {
204-
feature := entitlements.Features[codersdk.FeatureMultipleGitAuth]
203+
if externalAuthCount > 1 {
204+
feature := entitlements.Features[codersdk.FeatureMultipleExternalAuth]
205205

206206
switch feature.Entitlement {
207207
case codersdk.EntitlementNotEntitled:
208208
if entitlements.HasLicense {
209209
entitlements.Errors = append(entitlements.Errors,
210-
"You have multiple Git authorizations configured but your license is limited at one.",
210+
"You have multiple External Auth Providers configured but your license is limited at one.",
211211
)
212212
} else {
213213
entitlements.Errors = append(entitlements.Errors,
214-
"You have multiple Git authorizations configured but this is an Enterprise feature. Reduce to one.",
214+
"You have multiple External Auth Providers configured but this is an Enterprise feature. Reduce to one.",
215215
)
216216
}
217217
case codersdk.EntitlementGracePeriod:
218218
entitlements.Warnings = append(entitlements.Warnings,
219-
"You have multiple Git authorizations configured but your license is expired. Reduce to one.",
219+
"You have multiple External Auth Providers configured but your license is expired. Reduce to one.",
220220
)
221221
}
222222
}

‎enterprise/coderd/license/license_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ func TestEntitlements(t *testing.T) {
248248
if featureName == codersdk.FeatureHighAvailability {
249249
continue
250250
}
251-
if featureName == codersdk.FeatureMultipleGitAuth {
251+
if featureName == codersdk.FeatureMultipleExternalAuth {
252252
continue
253253
}
254254
niceName := featureName.Humanize()
@@ -484,7 +484,7 @@ func TestEntitlements(t *testing.T) {
484484
require.NoError(t, err)
485485
require.False(t, entitlements.HasLicense)
486486
require.Len(t, entitlements.Errors, 1)
487-
require.Equal(t, "You have multiple Git authorizations configured but this is an Enterprise feature. Reduce to one.", entitlements.Errors[0])
487+
require.Equal(t, "You have multiple External Auth Providers configured but this is an Enterprise feature. Reduce to one.", entitlements.Errors[0])
488488
})
489489

490490
t.Run("MultipleGitAuthNotEntitled", func(t *testing.T) {
@@ -499,12 +499,12 @@ func TestEntitlements(t *testing.T) {
499499
}),
500500
})
501501
entitlements, err := license.Entitlements(context.Background(), db, slog.Logger{}, 1, 2, coderdenttest.Keys, map[codersdk.FeatureName]bool{
502-
codersdk.FeatureMultipleGitAuth: true,
502+
codersdk.FeatureMultipleExternalAuth: true,
503503
})
504504
require.NoError(t, err)
505505
require.True(t, entitlements.HasLicense)
506506
require.Len(t, entitlements.Errors, 1)
507-
require.Equal(t, "You have multiple Git authorizations configured but your license is limited at one.", entitlements.Errors[0])
507+
require.Equal(t, "You have multiple External Auth Providers configured but your license is limited at one.", entitlements.Errors[0])
508508
})
509509

510510
t.Run("MultipleGitAuthGrace", func(t *testing.T) {
@@ -515,17 +515,17 @@ func TestEntitlements(t *testing.T) {
515515
GraceAt: time.Now().Add(-time.Hour),
516516
ExpiresAt: time.Now().Add(time.Hour),
517517
Features: license.Features{
518-
codersdk.FeatureMultipleGitAuth: 1,
518+
codersdk.FeatureMultipleExternalAuth: 1,
519519
},
520520
}),
521521
Exp: time.Now().Add(time.Hour),
522522
})
523523
entitlements, err := license.Entitlements(context.Background(), db, slog.Logger{}, 1, 2, coderdenttest.Keys, map[codersdk.FeatureName]bool{
524-
codersdk.FeatureMultipleGitAuth: true,
524+
codersdk.FeatureMultipleExternalAuth: true,
525525
})
526526
require.NoError(t, err)
527527
require.True(t, entitlements.HasLicense)
528528
require.Len(t, entitlements.Warnings, 1)
529-
require.Equal(t, "You have multiple Git authorizations configured but your license is expired. Reduce to one.", entitlements.Warnings[0])
529+
require.Equal(t, "You have multiple External Auth Providers configured but your license is expired. Reduce to one.", entitlements.Warnings[0])
530530
})
531531
}

‎site/src/api/typesGenerated.ts

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)