Add steps to configure MinIO with Check-in

[sebastian-luna-valero]

Summary

---

Related issue :

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[andrea-manzi]

@sebastian-luna-valero one first comment, is this a user tutorial or should be more of a Service provider tutorial? maybe we can start adding tutorials also under the service provider section

[sebastian-luna-valero]

Hi @andrea-manzi
Happy create a Service provider tutorial and move it down there. @gwarf please let us know your thoughts. Thanks!

[gwarf]

Hi @andrea-manzi Happy create a Service provider tutorial and move it down there. @gwarf please let us know your thoughts. Thanks!

So I'm unsure about who is the exact target, how this works, maybe it's a cross border case or a sign that our users/providers separation is sometimes too manichaeistic. Currently it indeeds look like it's for service providers, that said if compute users can also/usually work as some kind of service providers for their own community, by deploying services on top of our resources... I guess we could add it under the part for service providers, and link it in some way from the cloud compute part, if it's also something that can be relevant for a given user/community/VO willing/able to deploy it in a VM? @enolfc any opinion here?

[enolfc]

From a purely "Cloud Compute" point of view, this is user space and I would keep it under users. Using Check-in is great, but ToU and Privacy Notice need to be in place so this may not be so straightforward to setup for users.

@andrea-manzi do you think this is a viable option for providers to deliver online storage?

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[andrea-manzi]

From a purely "Cloud Compute" point of view, this is user space and I would keep it under users. Using Check-in is great, but ToU and Privacy Notice need to be in place so this may not be so straightforward to setup for users.

@andrea-manzi do you think this is a viable option for providers to deliver online storage?

Yes i think so, this I why we may include it in the service providers doc. For cloud providers already integrated with check-in there should be no problem to provide the ToU and Privacy Policy.

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[enolfc]

What we do about this one? Re-reading the text, there is no mention on how MinIO is to be deployed, so it's not a very user-oriented tutorial. If we agree this is an option to offer "Online Storage" service, it makes sense to have it in the providers section of the docs. Now:

1. do we try to mimic User docs organisation in providers and add this under Data -> Online Storage? If we do this, and we reorganise the rest of the content it would break links considerably

2. do we just add another top level section "Online Storage"?

3. do we add it in the current HOWTOs section?

I don't have a clear preference on this. Maybe option (2) is not breaking things and making it easy to find the content

[gwarf]

What we do about this one? Re-reading the text, there is no mention on how MinIO is to be deployed, so it's not a very user-oriented tutorial. If we agree this is an option to offer "Online Storage" service, it makes sense to have it in the providers section of the docs. Now:

1. do we try to mimic User docs organisation in providers and add this under Data -> Online Storage? If we do this, and we reorganise the rest of the content it would break links considerably
2. do we just add another top level section "Online Storage"?
3. do we add it in the current HOWTOs section?

I don't have a clear preference on this. Maybe option (2) is not breaking things and making it easy to find the content

For 1, we can add alias to limit link breakage, but I'm not sure it's currently required. I would avoid adding them to the Howto section, and in fact I would ideally see the content from that section moved to other better/proper places like many under HTC (or even dropped once they will be no more relevant).

So I guess that for now the step 2 makes sense as it is the easiest and more reasonable considering the time/effort available. It doesn't prevent doing a reorganisation after, keeping the old links working using aliases.

[andrea-manzi]

Yes i agree we can add a new section as suggested in point 2. To be further extended in the future with more documentation for storage installation, but we could start from what Sebastian added for Minio. @sebastian-luna-valero do you think you can apply the changes ?

[sebastian-luna-valero]

Sure, it's now done.

[github-actions[bot]]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view or the :scroll:action log for details.

Unrecognized words (1053)

``` AAAAAB AAAAABc AAAAB aad aae aaf aai aarc abcd abcda abe ABFK ABFKDm Accesspoint accesstoken Accounring Acitve actoridentifier adadc adea Adevice adf Administator adozione aef afc Aframework Agrant Aietf albalonga alex AMGA ansible Anupq Aoauth AOIz Aparams apel apgridpma apihost apikey appdb apprating appratingreport approprietely appsgrycap ARCCE arcget architecting arcproxy arcstat arcsub arctest arex ASGC asled aslo ASO ATL ATLASHOTDISK atlassian atnospam atrope atx authenticationauthorisation authenticaton automaticall autoprofixer autorisation autoscan Avanzato avialable avilable azp babzz backticks baee Bartosz Basemap bbaf bbd bbfd bcb bcc bcdmi bco bdcef bdii beb befd belongig BIFI biggrid binlog biomed BITP blcr BLOCKDEV blogspot BNL bonjovi Bosak bpclermont BRn browsable BTDYr BZBN cacerts cafiles calcolo carfully Cartopy caso catagory CATANIA ccb CCIN ccsrm cdmi ceb cec ced CEId ceph cephrgw certbot certificatoin certonly CESE cesga cesnet CETA cfc cfcabd cff cfssl cfssljson CHIPP Chipster ciemat cilogon cinderclient cirigridse cirros clcerts clickable clickhelp CLIs Clockspeed cloudadm cloudflare CLOUDIFIN cloudinit cloudkeeper cloudkey clouduser cmcc CMFs cmsgcert cmsglong cmsgshort cmsrm CMSSW cnaf cnf Codnor coid collegues cometa commiting commmand commnunities commonmark communitites Complext Computhng comunity condarc condb condorce configued consistencygroup consorzio contacttypes containerised contextualisation contextualise contextualization Contextualizator contextualized cou cremino Cristofori Cristoforiac CRUDL cryptsetup CSCS CSIRT currrent customisations customised customises cvmfs cxxxx CYFRONET dacyyyy daeae daf darkstorm dataanalysis datacube datadir datahub dataminer datascience datasicence datatracker dateadded davix dcbe dcc ddb ddfa DDTHH debian decomissioned defaut Desciption desy desync detailpage detault Dettach dfe dff DGAS dids Digi digicert dirac directoriy dissel dkrz dmf Dmoe DMSU dnf dnsupdate dnsupdater docid Dockerfiles dockerhub docsy dodas DOEFp DOIs doma domail domatest dpm DQDYx dteam dtzv dumpxml dutchgrid DVkcdpv dydns Dzivw eab ebc ebce ebd ebdf ebf ecas ecaslab ecf edac edee edg edittestreview edugain eduperson edupersonentitlement eed EEipdn eela efb efde egee egi EGIBG egicheckin egifedcloud EGIG eginotebooks EGIOLASL EGIPP EGISLM egispawner egiswift eiscat emi ENES enmr enolfc enpoint Ente environmnets eosatlas eosc epel eppn epuid errordesc errornum eudat eugridpma EUMED eumedgrid eur explaination explorecube extrator extremly EZhh faaae faai fadf fakedomaindonotexist Falre familar fasion fba fbd Fcb Fclient FCTF fdc fde fea feb fecaf fedcloud fedcloudclient fedoraproject fgt FHa finalise finalised FINISHEDDIRTY firefox firstcontributions fitsm flf floatingip floatip flushdns FNAL Folksonomy follwing follwoing FQAN FQDNs frontends FSAm FTn ftsmon ftssuite FWc fxgs FZK gaurav GBs Gci GCloud gcube geant genkey geoss getcontmsg getoutputs gfal gfalv GFD gfm ggf ggus giis gilda gisela gitbook gitleaks glite globusrun GMA gmbh gmlog GMya goc gocdb gocdbpi gohugo gohugoio goldmark golias gparam gpg gpgcheck gpgkey grafana gridftp GRIDICE gridit GRIDOPS gridpp Griglia grisu grnet groupof grycap gsdcs GSI gsidcap gsiftp gsissh gsoa gstore GVUJZRk HAi handover hashicorp haveged HDDs hellasgrid helpdesk hepgrid HEPi HEPIX hepspec hereu hervo heterogeneus Highighted highlighed HLR horstcert hostcert hostkey Howd howtoforge howtos HPDA htc htcondor htcondorce htf httpg HTTTPS HUYn Hvt hyperlinks Iaa IAP iat iber ibergrid ibrepifca ict IDAF IDLW ifca ifjsldkj igi igtf ihep IHF IISAS Ijoi ILM imdocs implmentation ims inaf incommon inferfaces infn infngrid infosites infrascture Infrastuctrure ingrid innodb installable ipykernel ipynb irisgrid isbn italiangrid Itemmscope Itemservice ITIL itselft Jaz jdl jdoe jdoepass jfgd Jhb jinr Jkd JKDm Jkphmes jkza Jle jobdescrfile jobid jobmanager jobsubmit JOL jovyan JQn Jra JSUz jti Jub juk jupyter jupyterhub Jva JWKS Jyc Jzd keycloak keyout keypair keyring keystoneauth KIPT klomp kube kubectl kubernetes labhub latchset Latitute lcglsf lcgnames lcgpbs ldapsearch Leqt letsencrypt lfc lfcserver lfn lhc lhcb LHT libcloud lightweigth LILLE lineinfile linkto linuxsoft LIPCA listmode liv LLL localdomain localgridmap logdir Lphp lpsc lrms lsd lsgc lto luks lxbra mainz makking maltekraus Mamonski managerv manangement Manzi mappedclasses mardkown Mariusz masterportal Matlab matplotlib mdattr MDM mds mdui memebers menbers Mers metalink mics middlewares minio mitaka MITR mke mlc Modifysection moin Moz mpi MPURI mscope multiattach multidisk mycluster myemail myenv mygridftp myhost myip mynode myproxy myserver mysqldump myvo Mzp NAMEICON nameid nbgitpuller nbis ncg NCh ndgf ndownloader nearline neccessary neighborhoud neovim netfilters NETOWRK neugrid NGDF ngi ngs ngstat nic NIDs nikhef nikosev nipne Nmam NMEM noarch noatime nobarrier nocerts nodedev nodiratime noip nokeys nordugrid northgrid nostreams notebooktest novaclient npmjs NPU nrandom NSUPATE nsupdate nsupdater ntf ntu ntugrid nuvw NVDIA Nza OAI oauthentication oauthenticator ocata occi offerint ofu ogf oidc oidcaccesstoken OIM OLAs ommitted oneclient onedata onedatify oneprovider Onezone OPaau opensciencegrid openstackclient openstacksite oph ophuser opsdisk opstest orcid ordanise orgaise Organisations osg osservices ost owslib PADOVA pagelength pageoffset pakiti paramter passthrough pbs peachnote permenant permissios Petabytes phassphrase phonem pkce plgrid pmamap PMH pnfs povided poweron poznan preinstalled priortiy prismjs processid progammatically promozione properlly PSNC Putra pvc Pxbjdnv pycon pyp qcf qcg qcow QNo qoscosgrid qsub QTRU quattor QVqk QWG qxx radl RAL ratingreport ratingsreport rcauth rciam rclone RDfg RDIG rdkit rdm reassignable recas refeds refering refreshtoken registeredon relatedapps repositority requres resorce restapi rfio Rght Rkqt RKv Rllk RNq roadmap roletype roma rpinitiated rpms rse rstudio RTX rucio rucioclient RUJ runcmd Rww rxtx samlp savba sbdii sbgcloud sbgcsrv SCAI scd schedd scipy scotgrid scs SDPK secmon secretkey sectigo SEFX Seletting seperated seqnumber Servcice servproject SFN sge SGs shortcode shub sibilla simplesamlphp singleuser sitei sitename skipcacheck slac SLAs slcs slideset slo slurm slurmserver smarch smcm softver somekey southgrid specifyting Splxl SPSSO srce srm srun Ssbmhk SSDs sshkey ssmsend sstc standardising statisticalmanager stedolan stfc Stichting Sto STORAGECLASS storagesite straighforward strandard stremsel Subbmiting submiting submitters SUBNAMESPACE subpage subresource succesfully sudmodules sumbit sunet sunstorm SURL SUs suspened SUy synchronises synchserver Synnefo tabpane tabpanex tabx tacar tapn tcs TCSNT tdviet Tecnologie tempkey templatefile terena terraform testadm TESTCERT testjob testvm textlint TFFd Tful tfvars tgz theophys thier ticketseditable timeleft timewise tonyxu topbdii torito tpctest TPMs TPU Tranfer transducerers Trjd trustanchors trx ttps TTT TTv twiki TXs uberftp ucert UCST uderstand Uhm uiniquely ukca UKNGS UKRI ULAKBIM umd undesrtand unicore Universiti untaring uploadclient upm upv Uqqs USCMS usecases usercert userguide userinfo userinterface userjdoe userkey Uwnavj validgrid vappliance vaules vaultproject VBWXQNENi vcpus vda vdb vdc VERCE veryverysecret VFm virgoglong virgogshort virsh virtualisation virtualised vjbms VJx vmcaster vmcatcher vmdk vmi vms VMUUID VObar VObaz VObing VObling VOBOX vogroup voms vomsdir vomses vomsrep voname voperson vopersonid vos vre VVJb vvv VYT wcnwxyti wcss WCTl WCXc Wcz webdav webfts webinar WIi wlcg WLCGNAME wmproxy WNs WOFOST wofostsystem WORKDIR worldmap wps WQi WRj wroc WSL xena Xeon xfs XGUDp xlarge xmlsoap xmpp Xptejd XPYURCLa xroot xrootd xrsl xsi Xsm xxxxae XYX xzd xzf yaim Yif youraccountname youremail yourhostname youtube yuin YWx YWxn zetta ZIb ZOn ZQQYb ZTz ZVkr zzzz ```

To accept :heavy_check_mark: these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [git@github.com:EGI-Federation/documentation.git](https://github.com/EGI-Federation/documentation.git) repository on the `main` branch ([:information_source: how do I use this?]( https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' | perl - 'https://github.com/EGI-Federation/documentation/actions/runs/4371704562/attempts/1' ```

Available :books: dictionaries could cover words not in the :blue_book: dictionary

Dictionary | Entries | Covers -|-|- [cspell:mnemonics/src/mnemonics.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/mnemonics/src/mnemonics.txt)|800|1| [cspell:cpp/src/lang-jargon.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/cpp/src/lang-jargon.txt)|11|1| Consider adding them using (in `.github/workflows/spelling.yml`): ``` yml with: extra_dictionaries: cspell:mnemonics/src/mnemonics.txt cspell:cpp/src/lang-jargon.txt ``` To stop checking additional dictionaries, add: ``` yml with: check_extra_dictionaries: '' ```

Pattern suggestions :scissors: (23)

You could add these patterns to .github/actions/spelling/patterns.txt: ``` # Automatically suggested patterns # hit-count: 830 file-count: 64 # https/http/file urls (?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|] # hit-count: 88 file-count: 14 # uuid: \b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b # hit-count: 86 file-count: 3 # Python stringprefix / binaryprefix # Note that there's a high false positive rate, remove the `?=` and search for the regex to see if the matches seem like reasonable strings (?"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) # hit-count: 16 file-count: 14 # GitHub SHAs (markdown) (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) # hit-count: 12 file-count: 3 # assign regex = /[^*].*/ # hit-count: 12 file-count: 2 # While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there # YouTube url \b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]* # hit-count: 11 file-count: 5 # version suffix v# (?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) # hit-count: 7 file-count: 3 # mailto urls mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,} # hit-count: 6 file-count: 2 # hex digits including css/html color classes: (?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b # hit-count: 4 file-count: 4 # printf %(?:(?:hh?|ll?|[jzt])?[diuoxXn]|l?[cs]|L?[fFeEgGaA]|p)(?=[a-zA-Z]{2,}) # hit-count: 4 file-count: 3 # Wikipedia \ben\.wikipedia\.org/wiki/[-\w%.#]+ # hit-count: 3 file-count: 3 # Contributor \[[^\]]+\]\(https://github\.com/[^/\s"]+\) # hit-count: 3 file-count: 1 # Amazon \bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|) # hit-count: 2 file-count: 2 # githubusercontent /[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* # hit-count: 2 file-count: 2 # Non-English [a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*|[a-zA-Z]{3,}[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]|[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3,} # hit-count: 2 file-count: 2 # tar arguments \b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+ # hit-count: 2 file-count: 1 # kubernetes pod status lists # https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase \w+(?:-\w+)+\s+\d+/\d+\s+(?:Running|Pending|Succeeded|Failed|Unknown)\s+ # hit-count: 1 file-count: 1 # The leading `/` here is as opposed to the `\b` above # ... a short way to match `https://` or `http://` since most urls have one of those prefixes # Google Docs /docs\.google\.com/[a-z]+/(?:ccc\?key=\w+|(?:u/\d+|d/(?:e/|)[0-9a-zA-Z_-]+/)?(?:edit\?[-\w=#.]*|/\?[\w=&]*|)) # hit-count: 1 file-count: 1 # IServiceProvider \bI(?=(?:[A-Z][a-z]{2,})+\b) # hit-count: 1 file-count: 1 # kubernetes object suffix -[0-9a-f]{10}-\w{5}\s ```

Errors (2)

See the [:open_file_folder: files](577/files/) view or the [:scroll:action log](https://github.com/EGI-Federation/documentation/actions/runs/4371704562/jobs/7647841617#step:2:1) for details. [:x: Errors](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) | Count -|- [:information_source: candidate-pattern](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#candidate-pattern) | 53 [:x: forbidden-pattern](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#forbidden-pattern) | 11 See [:x: Event descriptions](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions) for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ... * binary file (or some other file you wouldn't want to check at all). Please add a file path to the `excludes.txt` file matching the containing file. File paths are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( ../tree/HEAD/README.md) (on whichever branch you're using). * well-formed pattern. If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, try adding it to the `patterns.txt` file. Patterns are Perl 5 Regular Expressions - you can [test]( https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. Note that patterns can't match multiline strings.

:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling, please merge to your PR's base branch to get the version configured for your repository.

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[enolfc]

I think you need to add also a online-storage/_index.md for this to be rendered. See the datahub dir

[sebastian-luna-valero]

true, thanks!

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577

[sebastian-luna-valero]

ok, all tests passing now

[github-actions[bot]]

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/577