kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-01 16:05:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update UI, code comment, and README links to docs, tutorials (#26429)

Browse Source 
* Update UI, code comment, and README links to docs, tutorials

* fix typo in ephemeral disks learn more link url

* feedback on typo

Co-authored-by: Tim Gross <tgross@hashicorp.com>

---------

Co-authored-by: Tim Gross <tgross@hashicorp.com>
This commit is contained in:
Aimee Ukasick
2025-08-06 09:40:23 -05:00
committed by GitHub
parent 1c63ad50d9
commit a30cb2f137
38 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
ui/app/components/token-editor.hbs
View File

@@ -66,7 +66,7 @@
{{on "change" this.updateTokenExpirationTime}}>
</Hds::Form::TextInput::Field>
{{/if}}
{{else}}
<Hds::Form::Label>
{{#if @token.expirationTime}}
@@ -99,7 +99,7 @@
{{#if this.system.shouldShowRegions}}
<Hds::Form::Radio::Group data-test-global-token-group @layout="horizontal" @name="regional-or-global" {{on "change" this.updateTokenLocality}} as |G|>
<G.Legend>Token Region</G.Legend>
<G.HelperText>See <Hds::Link::Inline @href="https://developer.hashicorp.com/nomad/tutorials/access-control/access-control-tokens#token-replication-settings">ACL token fundamentals: Token replication settings</Hds::Link::Inline> for more information.</G.HelperText>
<G.HelperText>See <Hds::Link::Inline @href="https://developer.hashicorp.com/nomad/docs/secure/acl/tokens#token-replication-settings">ACL token fundamentals: Token replication settings</Hds::Link::Inline> for more information.</G.HelperText>
<G.RadioField
@id={{this.system.activeRegion}}
checked={{eq this.tokenRegion this.system.activeRegion}}
@@ -133,7 +133,7 @@
<div>
<Hds::Form::Radio::Group @layout="horizontal" @name="method-demo1" {{on "change" this.updateTokenType}} as |G|>
<G.Legend>Client or Management token?</G.Legend>
<G.HelperText>See <Hds::Link::Inline @href="https://developer.hashicorp.com/nomad/tutorials/access-control/access-control-tokens#token-types">Token types documentation</Hds::Link::Inline> for more information.</G.HelperText>
<G.HelperText>See <Hds::Link::Inline @href="https://developer.hashicorp.com/nomad/docs/secure/acl/tokens#token-types">Token types documentation</Hds::Link::Inline> for more information.</G.HelperText>
<G.RadioField
@id="client"
checked={{eq @token.type "client"}}

2
ui/app/routes/administration/policies/new.js
View File

@@ -6,7 +6,7 @@
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';
const INITIAL_POLICY_RULES = `# See https://developer.hashicorp.com/nomad/tutorials/access-control/access-control-policies for ACL Policy details
const INITIAL_POLICY_RULES = `# See https://developer.hashicorp.com/nomad/docs/secure/acl/policies for ACL Policy details
# Example policy structure:

4
ui/app/templates/administration/index.hbs
View File

@@ -7,8 +7,8 @@
<section class="intro">
<p>Your Nomad cluster has Access Control enabled, which you can use to control access to data and APIs. Here, you can manage the Tokens, Policies, and Roles for your system.</p>
<footer>
<Hds::Link::Standalone @icon="docs-link" @text="ACL System Fundamentals" @iconPosition="trailing" @href="https://developer.hashicorp.com/nomad/tutorials/access-control/access-control" />
<Hds::Link::Standalone @icon="docs-link" @text="ACL Policy Concepts" @iconPosition="trailing" @href="https://developer.hashicorp.com/nomad/tutorials/access-control/access-control-policies" />
<Hds::Link::Standalone @icon="docs-link" @text="ACL System Fundamentals" @iconPosition="trailing" @href="https://developer.hashicorp.com/nomad/docs/secure/acl" />
<Hds::Link::Standalone @icon="docs-link" @text="ACL Policy Concepts" @iconPosition="trailing" @href="https://developer.hashicorp.com/nomad/docs/secure/acl/policies" />
</footer>
</section>
<div class="section-cards">

2
ui/app/templates/administration/roles/role.hbs
View File

@@ -59,7 +59,7 @@
<h3>Create Tokens from the Nomad CLI</h3>
</div>
<div class="boxed-section-body">
<p>When you're ready to create more tokens, you can do so via the <a class="external-link" href="https://developer.hashicorp.com/nomad/docs/commands" target="_blank" rel="noopener noreferrer">Nomad CLI <Hds::Icon @name="external-link" @isInline={{true}} /></a> with the following:
<p>When you're ready to create more tokens, you can do so via the <a class="external-link" href="https://developer.hashicorp.com/nomad/commands" target="_blank" rel="noopener noreferrer">Nomad CLI <Hds::Icon @name="external-link" @isInline={{true}} /></a> with the following:
<pre>
<code>{{this.newTokenString}}</code>
<CopyButton

2
ui/app/templates/administration/sentinel-policies/index.hbs
View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: BUSL-1.1
<Hds::PageHeader class="variable-title" as |PH|>
<PH.Title>Sentinel Policies</PH.Title>
<PH.Description>
Nomad integrates with <Hds::Link::Inline @icon="collections" @href="https://developer.hashicorp.com/nomad/tutorials/governance-and-policy/sentinel">HashiCorp Sentinel</Hds::Link::Inline> to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
Nomad integrates with <Hds::Link::Inline @icon="collections" @href="https://developer.hashicorp.com/nomad/docs/govern/sentinel">HashiCorp Sentinel</Hds::Link::Inline> to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
</PH.Description>
<PH.Actions>
{{#if (can "write sentinel-policy")}}

2
ui/app/templates/administration/sentinel-policies/new.hbs
View File

@@ -9,7 +9,7 @@
<Hds::PageHeader class="variable-title" as |PH|>
<PH.Title>Create Sentinel Policy</PH.Title>
<PH.Description>
Nomad integrates with <Hds::Link::Inline @icon="collections" @href="https://developer.hashicorp.com/nomad/tutorials/governance-and-policy/sentinel">HashiCorp Sentinel</Hds::Link::Inline> to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
Nomad integrates with <Hds::Link::Inline @icon="collections" @href="https://developer.hashicorp.com/nomad/docs/govern/sentinel">HashiCorp Sentinel</Hds::Link::Inline> to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
</PH.Description>
<PH.Actions>
<Hds::Button

2
ui/app/templates/application.hbs
View File

@@ -59,7 +59,7 @@
<h1 data-test-error-title class="title is-spaced">No Cluster Leader</h1>
<p data-test-error-message class="subtitle">
The cluster has no leader.
<a href="https://developer.hashicorp.com/nomad/tutorials/manage-clusters/outage-recovery">
<a href="https://developer.hashicorp.com/nomad/docs/manage/outage-recovery">
Read about Outage Recovery.</a>
</p>
{{else if this.isOTTExchange}}

2
ui/app/templates/jobs/index.hbs
View File

@@ -13,7 +13,7 @@
<A.Button data-test-pause-fetching @text="Stop polling for job updates" @color="secondary" {{on "click" this.pauseJobFetching}} />
{{/if}}
<A.Button data-test-restart-fetching @text="Manually fetch jobs" @color="secondary" {{on "click" this.restartJobList}} />
<A.LinkStandalone @size="medium" @color="primary" @icon="learn-link" @iconPosition="trailing" @text="Tutorial: Configure reverse proxy for Nomad's web UI" @href="https://developer.hashicorp.com/nomad/tutorials/manage-clusters/reverse-proxy-ui#extend-connection-timeout" />
<A.LinkStandalone @size="medium" @color="primary" @icon="learn-link" @iconPosition="trailing" @text="Tutorial: Configure reverse proxy for Nomad's web UI" @href="https://developer.hashicorp.com/nomad/docs/deploy/clusters/reverse-proxy-ui#extend-connection-timeout" />
</Hds::Alert>
{{/if}}

4
ui/app/templates/jobs/job/variables.hbs
View File

@@ -14,7 +14,7 @@
<A.Description>
<p>Tasks in this job can have <Hds::Link::Inline @href="https://developer.hashicorp.com/nomad/docs/concepts/variables#task-access-to-variables" target="_blank" rel="noopener noreferrer">automatic access to Nomad Variables</Hds::Link::Inline>.</p>
<ul>
<li data-test-variables-intro-all-jobs>Use
<li data-test-variables-intro-all-jobs>Use
<code>
<EditableVariableLink @path="nomad/jobs" @existingPaths={{this.jobRelevantVariables.files}} @namespace={{this.model.job.namespace.name}} />
</code>
@@ -55,7 +55,7 @@
</li>
</ul>
</A.Description>
<A.LinkStandalone @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more about Nomad Variables" @href="https://developer.hashicorp.com/nomad/tutorials/variables" />
<A.LinkStandalone @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more about Nomad Variables" @href="https://developer.hashicorp.com/nomad/docs/job-declare/nomad-variables" />
</Hds::Alert>
</header>

4
ui/app/templates/storage/index.hbs
View File

@@ -231,7 +231,7 @@
<A.Description>
Defined in the Nomad agent's config file, best for infrequently changing storage
</A.Description>
<A.Button @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more" @href="https://developer.hashicorp.com/nomad/tutorials/stateful-workloads/stateful-workloads-host-volumes" />
<A.Button @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more" @href="https://developer.hashicorp.com/nomad/docs/stateful-workloads/static-host-volumes" />
</Hds::Alert>
<Hds::Alert @type="inline" @color="highlight" @icon="hard-drive" as |A|>
<A.Title>
@@ -240,7 +240,7 @@
<A.Description>
Best-effort persistence, ideal for rebuildable data. Stored in the <code>/alloc/data</code> directory in a given allocation.
</A.Description>
<A.Button @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more" @href="https://developer.hashicorp.com/nomad/docs/operations/stateful-workloads#ephemeral-disks" />
<A.Button @color="secondary" @icon="arrow-right" @iconPosition="trailing" @text="Learn more" @href="https://developer.hashicorp.com/nomad/docs/architecture/storage/stateful-workloads#ephemeral-disks" />
</Hds::Alert>
</Hds::Card::Container>