forked from CSCfi/csc-user-guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
254 lines (245 loc) · 13.1 KB
/
mkdocs.yml
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
242
243
244
245
246
247
248
249
250
251
252
253
254
site_name: Docs CSC
edit_uri: "https://github.com/CSCfi/csc-user-guide/edit/master/docs"
site_url: "https://docs.csc.fi/"
site_description: Instructions and user guides for the CSC supercomputers, cloud services, storage and software, including FAQ and tutorials
nav:
- Home: index.md
- Accounts:
- Overview: accounts/index.md
- Creating a new user account: accounts/how-to-create-new-user-account.md
- Changing your password: accounts/how-to-change-password.md
- Managing user information: accounts/how-to-manage-user-information.md
- Creating a new project: accounts/how-to-create-new-project.md
- When your project handles personal data: accounts/when-your-project-handles-personal-data.md
- Adding members to your project: accounts/how-to-add-members-to-project.md
- Adding service access for your project: accounts/how-to-add-service-access-for-project.md
- Managing your project: accounts/how-to-manage-your-project.md
- Applying for billing units: accounts/how-to-apply-for-billing-units.md
- Increasing disk quotas: accounts/how-to-increase-disk-quotas.md
- Accessing Mahti large partition: accounts/how-to-access-mahti-large-partition.md
- Reviewing billing unit usage: accounts/how-to-view-billing-unit-usage.md
- Billing: accounts/billing.md
- Multi-factor Authentication: accounts/mfa.md
- FMI: accounts/fmi.md
- Computing:
- Overview: computing/overview.md
- Systems:
- Available systems: computing/available-systems.md
- Puhti: computing/systems-puhti.md
- Mahti: computing/systems-mahti.md
- LUMI: "https://docs.lumi-supercomputer.eu/generic/overview/"
- Kvasi: computing/kvasi.md
- Connecting: computing/connecting.md
- Supercomputer storage:
- Disk areas: computing/disk.md
- Lustre filesystem: computing/lustre.md
- Allas object storage: computing/allas.md
- Module environment: computing/modules.md
- Running jobs:
- Getting started: computing/running/getting-started.md
- Create Puhti batch jobs: computing/running/creating-job-scripts-puhti.md
- Puhti example scripts: computing/running/example-job-scripts-puhti.md
- Create Mahti batch jobs: computing/running/creating-job-scripts-mahti.md
- Mahti example scripts: computing/running/example-job-scripts-mahti.md
- Submitting a job: computing/running/submitting-jobs.md
- Available batch job partitions: computing/running/batch-job-partitions.md
- High throughput: computing/running/throughput.md
- Interactive usage: computing/running/interactive-usage.md
- Performance checklist: computing/running/performance-checklist.md
- Compiling:
- Puhti: computing/compiling-puhti.md
- Mahti: computing/compiling-mahti.md
- LUMI: computing/compiling-lumi.md
- High performance libraries: computing/hpc-libraries.md
- Debugging: computing/debugging.md
- Performance analysis: computing/performance.md
- Containers:
- Overview: computing/containers/overview.md
- Running containers: computing/containers/run-existing.md
- Creating containers: computing/containers/creating.md
- Container wrapper (Tykky): computing/containers/tykky.md
- Web interface:
- Overview: computing/webinterface/index.md
- Interactive apps:
- Accelerated visualization: computing/webinterface/accelerated-visualization.md
- Desktop: computing/webinterface/desktop.md
- Jupyter: computing/webinterface/jupyter.md
- Jupyter for courses: computing/webinterface/jupyter-for-courses.md
- RStudio: computing/webinterface/rstudio.md
- TensorBoard: computing/webinterface/tensorboard.md
- Visual Studio Code: computing/webinterface/vscode.md
- Cloud:
- Concepts of cloud computing: cloud/concepts.md
- Rahti:
- Contents: cloud/rahti/index.md
- What is Rahti: cloud/rahti/rahti-what-is.md
- Containers & their Orchestration: cloud/rahti/containers.md
- Kubernetes and OpenShift concepts: cloud/rahti/concepts.md
- Networking: cloud/rahti/networking.md
- Security guide: cloud/rahti/security-guide.md
- Getting Started:
- Getting access: cloud/rahti/access.md
- Using the web interface: cloud/rahti/usage/getting_started.md
- Command line tool installation and usage: cloud/rahti/usage/cli.md
- Rahti Tutorials:
- Deploying a static web server using the web interface: cloud/rahti/tutorials/basic-console.md
- Deploying a static web server using the command line: cloud/rahti/tutorials/elemental_tutorial.md
- Custom domain names and secure transport: cloud/rahti/tutorials/custom-domain.md
- Configuration, ConfigMaps and Secrets: cloud/rahti/tutorials/configuration.md
- Webhooks: cloud/rahti/tutorials/webhooks.md
- Reverse proxy authentication using a sidecar container: cloud/rahti/tutorials/sidecar_proxy_authentication.md
- Short introduction to YAML: cloud/rahti/tutorials/yaml_introduction.md
- How to transfer data to Rahti?: cloud/rahti/tutorials/transfer_data_rahti.md
- How to add docker hub credentials to a project: cloud/rahti/tutorials/docker_hub_login.md
- How to manually cache images in Rahti's registry: cloud/rahti/tutorials/docker_hub_manual_caching.md
- CI/CD on Rahti: cloud/rahti/tutorials/ci_cd_introduction.md
- How to run an ad-hoc interactive container: cloud/rahti/tutorials/oc-run.md
- How backup a Postgres DB into Allas: cloud/rahti/tutorials/backup-postgres-allas.md
- Annotations: cloud/rahti/tutorials/annotations.md
- Sending e-mail from Rahti: cloud/rahti/tutorials/email.md
- Accessing databases on Rahti from CSC supercomputers: cloud/rahti/tutorials/connect-database-hpc.md
- Multi stage builds: cloud/rahti/tutorials/multi-stage-builds.md
- Storage in Rahti:
- Available storage options: cloud/rahti/storage/index.md
- Persistent volumes: cloud/rahti/storage/persistent.md
- Ephemeral storage: cloud/rahti/storage/ephemeral.md
- Expand a volume: cloud/rahti/storage/expand-volumes.md
- Images:
- Overview: cloud/rahti/images/overview.md
- Creating an image: cloud/rahti/images/creating.md
- Keeping docker images small: cloud/rahti/images/keeping_docker_images_small.md
- GPU in Rahti: cloud/rahti/gpu.md
- Rahti Templates: cloud/rahti/template-docs.md
- Projects and quota: cloud/rahti/usage/projects_and_quota.md
- Billing: cloud/rahti/billing.md
- External documentation: cloud/rahti/ext_docs.md
- Pouta:
- Contents: cloud/pouta/index.md
- What is Pouta: cloud/pouta/pouta-what-is.md
- Security Guidelines for Pouta: cloud/pouta/security.md
- Pouta Accounting Principles and Quotas: cloud/pouta/accounting.md
- Virtual machine flavors and Billing Unit rates: cloud/pouta/vm-flavors-and-billing.md
- Getting started with Pouta:
- Launching a virtual machine with the cPouta web interface: cloud/pouta/launch-vm-from-web-gui.md
- Connecting to your virtual machine: cloud/pouta/connecting-to-vm.md
- Install command line tools: cloud/pouta/install-client.md
- Command line client tools: cloud/pouta/command-line-tools.md
- API Access to Pouta: cloud/pouta/api-access.md
- Virtual machine lifecycle & saving billing units: cloud/pouta/vm-lifecycle.md
- Storage in Pouta:
- Available storage options: cloud/pouta/storage.md
- Ephemeral storage: cloud/pouta/ephemeral-storage.md
- Persistent volumes: cloud/pouta/persistent-volumes.md
- Snapshots: cloud/pouta/snapshots.md
- Images:
- Basic information about images: cloud/pouta/images.md
- Creating, Converting, Uploading and Sharing virtual machine images: cloud/pouta/adding-images.md
- Orchestration with Heat: cloud/pouta/heat-orchestration.md
- Application Development Practises in Pouta: cloud/pouta/application-dev.md
- Additional services in Pouta (email, dns): cloud/pouta/additional-services.md
- Self study and troubleshooting:
- Pouta videos: cloud/pouta/pouta-videos.md
- Known problems and limitations: cloud/pouta/known-problems.md
- Grid computing:
- The Grid Monitor: cloud/grid/grid-monitor.md
- CSC Notebooks:
- Overview: cloud/csc_notebooks/index.md
- Guide for students: cloud/csc_notebooks/guide_for_students.md
- Guide for teachers: cloud/csc_notebooks/guide_for_teachers.md
- Concepts: cloud/csc_notebooks/concepts.md
- Data persistence: cloud/csc_notebooks/data_persistence.md
- Migration to beta: cloud/csc_notebooks/migration_to_beta.md
- Data:
# - Datasets: data/datasets.md
- Working with data:
- Contents: data/datasets/dataset-sources.md
- Tips for data management: data/datasets/datamanagement.md
- Metadata and data documentation: data/datasets/metadata-and-documentation.md
- Dataset sources: data/datasets/sourcing-datasets.md
- Storing data at CSC: data/datasets/hosting-datasets-at-CSC.md
- Publishing datasets: data/datasets/publishing-datasets.md
- Moving data:
- Copying files using scp: data/moving/scp.md
- Graphical file transfer tools: data/moving/graphical_transfer.md
- Using rsync for data transfer and synchronization: data/moving/rsync.md
- Using wget to download data from web sites to CSC: data/moving/wget.md
- Sharing and transporting files using Funet FileSender: data/moving/funet.md
- Moving data between IDA and CSC computing environment: data/ida/using_ida.md
- Remote disk mounts: data/moving/disk_mount.md
- Copying data between Allas and IDA via Puhti: data/moving/copy_allas_ida.md
- Allas object storage:
- Overview: data/Allas/index.md
- Introduction to Allas Storage service: data/Allas/introduction.md
- Accessing Allas: data/Allas/accessing_allas.md
- Common Use Cases: data/Allas/using_allas/common_use_cases.md
- Common Error Messages: data/Allas/using_allas/error_messages.md
- Further information: data/Allas/further_info.md
- cPouta object storage and Allas: data/Allas/allas_cpouta_change.md
- Allas object storage related terms and concepts: data/Allas/terms_and_concepts.md
- Sensitive data:
- Contents: data/sensitive-data/index.md
- Introduction: data/sensitive-data/intro.md
- SD Connect: data/sensitive-data/sd_connect.md
- SD Desktop: data/sensitive-data/sd_desktop.md
- Audited SD Desktop for registry data: data/sensitive-data/sd-desktop-audited.md
# - FederatedEGA: data/sensitive-data/federatedega.md
# - SD Apply: data/sensitive-data/sd-apply.md
# - Containers: data/sensitive-data/creating_containers.md
- Kaivos database service:
- Kaivos overview: data/kaivos/overview.md
- Getting a database account: data/kaivos/kaivos-account.md
- MySQL client programs at CSC: data/kaivos/kaivos_client_in_puhti.md
- Data import and export: data/kaivos/kaivos_import.md
- Using MySQL client through batch job system: data/kaivos/kaivos_batch_job.md
- Using kaivos.csc.fi directly from your local computer: data/kaivos/kaivos_remote.md
- Using Perl MySQL API at CSC: data/kaivos/kaivos_perl.md
# Python MySQL API at CSC:
- Applications:
- In alphabetical order: apps/alpha.md
- By discipline: apps/index.md
- By availability: apps/by_system.md
- FAQ: support/faq/index.md
- Tutorials: support/tutorials/index.md
- Training material: support/training-material.md
- Contact: support/contact.md
- What's new: support/whats-new.md
theme:
name: material
custom_dir: mkdocs_csc/
font:
text: 'museo-sans'
code: 'Source Code Pro'
logo: 'img/Docs_CSC_logo.svg#headerlogo'
cscfi_logo: 'img/CSCfi_text.png#headerlogo'
mycsc_logo: 'img/MyCSC_text.png#headerlogo'
research_logo: 'img/Research_text.png#headerlogo'
extra_css:
- 'assets/stylesheets/tabbed.css'
- 'assets/stylesheets/extra.css'
- 'assets/stylesheets/extra_mobile.css'
- 'https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.css'
- 'https://use.typekit.net/csv4mjm.css'
extra_javascript:
- 'assets/javascripts/extra.js'
- "https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.js"
- 'assets/javascripts/cookie_consent.js'
- "https://unpkg.com/mermaid/dist/mermaid.min.js"
markdown_extensions:
- toc:
toc_depth: 1-6
- admonition
- abbr
- attr_list
- def_list
- pymdownx.details
- pymdownx.tabbed
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
extra:
analytics:
provider: google
property: UA-5406715-9