Skip to content

Commit ca1091f

Browse files
committed
doc : Add steps to remove CRC pull secret from OS provided tools (#2572)
Add steps for Windows, Linux (GNOME) and MacOS to instruct user on how to remove the CRC pull secret from credential managers on abovementioned Operating Systems. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
1 parent c1b6082 commit ca1091f

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

modules/ROOT/pages/using.adoc

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,102 @@ $ crc setup # Initialize environment for cluster
9595
$ crc start # Start the cluster
9696
----
9797

98+
[id='about-pullsecrets']
99+
== About Pull Secrets
100+
When using the {openshift} or {ushift} preset, {prod} requires pull secret:
101+
102+
. To pull the virtual machine bundle.
103+
. To pull {ocp} container images from the Red Hat registry.
104+
105+
When running [command]`{bin} start` the first time, when the pull secret has not been provisioned, {prod} prompts to provide a pull secret.
106+
107+
=== Providing pull secret to {prod}
108+
109+
.Prerequisites
110+
. Download pull secret from the Pull Secret section of the link:https://console.redhat.com/openshift/create/local[{prod} page on the {rh} Hybrid Cloud Console] to _<pull_secret_file>_ location.
111+
112+
.Procedure
113+
* Enter pull secret value when {prod} prompts to provide pull secret.
114+
{prod} stores the pull secret in the Operating System's credential manager so that {prod} doesn't ask for pull secret again in case existing cluster is deleted and a new one is created.
115+
+
116+
[subs="+attributes,+quotes"]
117+
----
118+
$ {bin} start
119+
...
120+
? Please enter the pull secret
121+
----
122+
+
123+
[TIP]
124+
====
125+
Alternatively, specify pull secret file location by using the `--pull-secret-file` CLI argument.
126+
[subs="+attributes,+quotes"]
127+
----
128+
$ {bin} start --pull-secret-file=_<pull_secret_file>_
129+
----
130+
====
131+
+
132+
[TIP]
133+
====
134+
Alternatively, specify pull secret file location by setting the `pull-secret-file` configuration.
135+
[subs="+attributes,+quotes"]
136+
----
137+
$ {bin} config set pull-secret-file _<pull_secret_file>_
138+
$ {bin} start
139+
----
140+
====
141+
142+
Please note that this pull secret would only be removed from the Operating System's credential manager when user runs [command]`{bin} cleanup` command.
143+
144+
It's also possible to remove pull secret from the Operating System's credential manager configuration manually.
145+
146+
[id='clearning-credential-manager-pullsecret']
147+
=== Clearing Pull Secret from Credential Manager
148+
Steps to clear entries from the Credential Manager on different operating systems.
149+
150+
==== Windows
151+
152+
. Open the Control Panel.
153+
. Go to `User Accounts` > `Credential Manager`.
154+
. Choose `Windows Credentials`.
155+
. Find the {prod} pull secret entry to delete.
156+
. Click on the entry to expand it.
157+
. Click `Remove` to delete the credential.
158+
159+
==== Linux
160+
161+
If using https://wiki.gnome.org/Projects/GnomeKeyring[GNOME Keyring]:
162+
163+
. Open the `Activities` overview and start typing `Passwords`.
164+
. Click on `Passwords and Keys` to open https://wiki.gnome.org/Projects/GnomeKeyring[GNOME Keyring].
165+
. Click on `Login` entry under `Passwords`
166+
. Find the {prod} pull secret entry to delete.
167+
. Right-click the entry to delete.
168+
. Select `Delete` and confirm the deletion.
169+
170+
If using https://github.com/KDE/kwallet[KDE Wallet]:
171+
172+
[NOTE]
173+
====
174+
By default, https://github.com/KDE/kwallet[KDE Wallet] doesn't operate as a Secret Service Provider. This needs to be explicitly
175+
enable it by going to `System Settings` > `KDE Wallet` and enable Use KWallet for the Secret Service interface. Then {prod} can be used
176+
with https://github.com/KDE/kwallet[KDE Wallet]
177+
====
178+
179+
. Open the `Application Launcher` and start typing `KWalletManager`.
180+
. Under `Contents` tab, click on `Secret Service` and expand it.
181+
. Under expanded `Secret Service` entry, click on `Passwords` and expand it.
182+
. Find the {prod} pull secret entry.
183+
. Right-click the entry to delete.
184+
. Select `Delete` and confirm the deletion.
185+
186+
==== MacOS
187+
188+
. Open `Keychain Access` from the `Applications` > `Utilities` folder.
189+
. Select the keychain where the credential is stored (e.g., `login`, `iCloud`).
190+
. Find the {prod} pull secret entry to delete.
191+
. Right-click the entry and select `Delete`.
192+
. Confirm the deletion when prompted.
193+
98194
[id='setting-up']
99195
== Setting up {prod}
100196

0 commit comments

Comments
 (0)