1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<script>
import { GlIcon, GlLink, GlSprintf, GlSkeletonLoader } from '@gitlab/ui';
import ClipboardButton from '~/vue_shared/components/clipboard_button.vue';
import { createAlert } from '~/alert';
import { s__, sprintf } from '~/locale';
import { convertToGraphQLId } from '~/graphql_shared/utils';
import { TYPENAME_CI_RUNNER } from '~/graphql_shared/constants';
import runnerForRegistrationQuery from '../../graphql/register/runner_for_registration.query.graphql';
import {
STATUS_ONLINE,
EXECUTORS_HELP_URL,
SERVICE_COMMANDS_HELP_URL,
RUNNER_REGISTRATION_POLLING_INTERVAL_MS,
I18N_FETCH_ERROR,
I18N_REGISTRATION_SUCCESS,
} from '../../constants';
import { captureException } from '../../sentry_utils';
import CliCommand from './cli_command.vue';
import { commandPrompt, registerCommand, runCommand } from './utils';
export default {
name: 'RegistrationInstructions',
components: {
GlIcon,
GlLink,
GlSkeletonLoader,
GlSprintf,
ClipboardButton,
CliCommand,
},
props: {
runnerId: {
type: String,
required: true,
},
platform: {
type: String,
required: true,
},
},
data() {
return {
runner: null,
token: null,
};
},
apollo: {
runner: {
query: runnerForRegistrationQuery,
variables() {
return {
id: convertToGraphQLId(TYPENAME_CI_RUNNER, this.runnerId),
};
},
manual: true,
result({ data }) {
if (data?.runner) {
const { ephemeralAuthenticationToken, ...runner } = data.runner;
this.runner = runner;
// The token is available in the API for a limited amount of time
// preserve its original value if it is missing after polling.
this.token = ephemeralAuthenticationToken || this.token;
}
},
error(error) {
createAlert({ message: I18N_FETCH_ERROR });
captureException({ error, component: this.$options.name });
},
pollInterval() {
if (this.runner?.status === STATUS_ONLINE) {
// stop polling
return 0;
}
return RUNNER_REGISTRATION_POLLING_INTERVAL_MS;
},
},
},
computed: {
loading() {
return this.$apollo.queries.runner.loading;
},
description() {
return this.runner?.description;
},
heading() {
if (this.description) {
return sprintf(
s__('Runners|Register "%{runnerDescription}" runner'),
{
runnerDescription: this.description,
},
false,
);
}
return s__('Runners|Register runner');
},
status() {
return this.runner?.status;
},
tokenMessage() {
if (this.token) {
return s__(
'Runners|The %{boldStart}runner token%{boldEnd} %{token} displays %{boldStart}only for a short time%{boldEnd}, and is stored in the %{codeStart}config.toml%{codeEnd} after you register the runner. It will not be visible once the runner is registered.',
);
}
return s__(
'Runners|The %{boldStart}runner token%{boldEnd} is no longer visible, it is stored in the %{codeStart}config.toml%{codeEnd} if you have registered the runner.',
);
},
commandPrompt() {
return commandPrompt({ platform: this.platform });
},
registerCommand() {
return registerCommand({
platform: this.platform,
registrationToken: this.token,
description: this.description,
});
},
runCommand() {
return runCommand({ platform: this.platform });
},
},
methods: {
toggleDrawer() {
this.$emit('toggleDrawer');
},
},
EXECUTORS_HELP_URL,
SERVICE_COMMANDS_HELP_URL,
STATUS_ONLINE,
I18N_REGISTRATION_SUCCESS,
};
</script>
<template>
<div>
<h1 class="gl-font-size-h1">{{ heading }}</h1>
<p>
<gl-sprintf
:message="
s__(
'Runners|GitLab Runner must be installed before you can register a runner. %{linkStart}How do I install GitLab Runner?%{linkEnd}',
)
"
>
<template #link="{ content }">
<gl-link data-testid="runner-install-link" @click="toggleDrawer">{{ content }}</gl-link>
</template>
</gl-sprintf>
</p>
<section>
<h2 class="gl-font-size-h2">{{ s__('Runners|Step 1') }}</h2>
<p>
{{
s__(
'Runners|Copy and paste the following command into your command line to register the runner.',
)
}}
</p>
<gl-skeleton-loader v-if="loading" />
<template v-else>
<cli-command :prompt="commandPrompt" :command="registerCommand" />
<p>
<gl-icon name="information-o" class="gl-text-blue-600!" />
<gl-sprintf :message="tokenMessage">
<template #token>
<code data-testid="runner-token">{{ token }}</code>
<clipboard-button
:text="token"
:title="__('Copy')"
size="small"
category="tertiary"
class="gl-border-none!"
/>
</template>
<template #bold="{ content }"
><span class="gl-font-weight-bold">{{ content }}</span></template
>
<template #code="{ content }"
><code>{{ content }}</code></template
>
</gl-sprintf>
</p>
</template>
</section>
<section>
<h2 class="gl-font-size-h2">{{ s__('Runners|Step 2') }}</h2>
<p>
<gl-sprintf
:message="
s__(
'Runners|Choose an executor when prompted by the command line. Executors run builds in different environments. %{linkStart}Not sure which one to select?%{linkEnd}',
)
"
>
<template #link="{ content }">
<gl-link :href="$options.EXECUTORS_HELP_URL" target="_blank">
{{ content }} <gl-icon name="external-link" />
</gl-link>
</template>
</gl-sprintf>
</p>
</section>
<section>
<h2 class="gl-font-size-h2">{{ s__('Runners|Step 3 (optional)') }}</h2>
<p>{{ s__('Runners|Manually verify that the runner is available to pick up jobs.') }}</p>
<cli-command :prompt="commandPrompt" :command="runCommand" />
<p>
<gl-sprintf
:message="
s__(
'Runners|This may not be needed if you manage your runner as a %{linkStart}system or user service%{linkEnd}.',
)
"
>
<template #link="{ content }">
<gl-link :href="$options.SERVICE_COMMANDS_HELP_URL" target="_blank">
{{ content }} <gl-icon name="external-link" />
</gl-link>
</template>
</gl-sprintf>
</p>
</section>
<section v-if="status == $options.STATUS_ONLINE">
<h2 class="gl-font-size-h2">🎉 {{ $options.I18N_REGISTRATION_SUCCESS }}</h2>
<p class="gl-pl-6">
<gl-sprintf :message="s__('Runners|To view the runner, go to %{runnerListName}.')">
<template #runnerListName>
<span class="gl-font-weight-bold"><slot name="runner-list-name"></slot></span>
</template>
</gl-sprintf>
</p>
</section>
</div>
</template>
|
