diff --git a/404.html b/404.html index 204c19fce5..1c6e6ff42a 100644 --- a/404.html +++ b/404.html @@ -9,10 +9,10 @@ - - + + -
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

\ No newline at end of file diff --git a/about_our_contributors/index.html b/about_our_contributors/index.html index d386c3cfc4..b11017f95a 100644 --- a/about_our_contributors/index.html +++ b/about_our_contributors/index.html @@ -9,11 +9,11 @@ - - + + -
Skip to main content

Below is a list of contibutors who have contributed to the +

Below is a list of contibutors who have contributed to the source code & their employers.

Should you wish to contribute to the Rucio source code or the documentation, please ensure you go through the guidelines listed in the contribution guide @@ -106,6 +106,6 @@

Organisations employing contributors

  • Institut Teknologi Bandung (Indonesia)
  • Universität Hamburg (Germany)
  • Brazilian Center for Research in Physics (Brazil)
    • -
    Copyright © 2023 CERN
    +
    \ No newline at end of file diff --git a/assets/js/03a88bad.ab52796d.js b/assets/js/03a88bad.ab52796d.js deleted file mode 100644 index 7b28f24f25..0000000000 --- a/assets/js/03a88bad.ab52796d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8078],{57699:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"index","title":"Welcome to Rucio\'s documentation","description":"Rucio is a project that provides services and associated libraries for allowing","source":"@site/../docs/index.md","sourceDirName":".","slug":"/","permalink":"/documentation/","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/index.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"index","title":"Welcome to Rucio\'s documentation","sidebar_label":"Welcome","slug":"/"},"sidebar":"docs","next":{"title":"Before you get started","permalink":"/documentation/started/before_you_get_started"}}');var o=n(74848),s=n(28453);const r={id:"index",title:"Welcome to Rucio's documentation",sidebar_label:"Welcome",slug:"/"},a=void 0,c={},l=[{value:"Getting Started",id:"getting-started",level:2},{value:"Client",id:"client",level:2},{value:"Administration",id:"administration",level:2},{value:"Developer Documentation",id:"developer-documentation",level:2},{value:"Contributing to the Documentation",id:"contributing-to-the-documentation",level:2},{value:"About Us",id:"about-us",level:2}];function d(e){const t={a:"a",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Rucio is a project that provides services and associated libraries for allowing\nscientific collaborations to manage large volumes of data spread across\nfacilities at multiple institutions and organisations. Rucio was originally\ndeveloped to meet the requirements of the high-energy physics experiment\n",(0,o.jsx)(t.a,{href:"https://atlas.cern/",children:"ATLAS"}),", and now is continuously extended to support the\nLHC experiments and other diverse scientific communities."]}),"\n",(0,o.jsx)(t.p,{children:"Rucio offers advanced features, is highly scalable, and modular. It is a data\nmanagement solution that covers the needs of different communities in the\nscientific domain (e.g., HEP, astronomy, biology)."}),"\n",(0,o.jsx)(t.p,{children:"Below are some resources to help you get you started on your journey."}),"\n",(0,o.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,o.jsx)(t.p,{children:"What exactly is Rucio? What were the motivations behind developing such a\nsystem? Who uses it? What powers these systems? Answers to all these questions\nand more can be found by browsing through the sub-sections of this topic."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/what_is_rucio",children:"What is Rucio"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/main_components",children:"Main Components"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/additional_layers_and_resources",children:"Additional Layers and Resources"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"client",children:"Client"}),"\n",(0,o.jsx)(t.p,{children:"The rucio client enables users to interact with the system and access the\ndistributed data. The client can upload, download, manage and delete everything\nfrom single files up to Petabyte sized datasets."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/setting_up_the_rucio_client",children:"Setting Up the Rucio Client"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/using_the_client",children:"Using the Client"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/using_the_admin_client",children:"Using the Admin Client"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"administration",children:"Administration"}),"\n",(0,o.jsx)(t.p,{children:"This section of the documentation deals with some of the material that an\noperator or administrator of a Rucio environment would require. For example, how\nto install a server or some quick tips for working with the administrative\nCLI. Take a deep dive, but not before you ensure you've read through the\npre-requisites section under each of the topics!"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/setting_up_demo",children:"Setting up a Rucio demo environment"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/installing_server",children:"Installing Rucio Server"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/installing_daemons",children:"Installing Rucio Daemons"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/monitoring",children:"Monitoring"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"operator/database",children:"Database"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/configuration_parameters",children:"Configuration parameters"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"developer-documentation",children:"Developer Documentation"}),"\n",(0,o.jsx)(t.p,{children:"Whether you want to develop with Rucio or contribute to the project, the\nDeveloper documentation will help you get started. Peruse some common REST API &\nClient API references that are directly derived from Rucio's python\nlibraries. We also have a contribution guide for those who wish to pitch in."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"client_api/accountclient",children:"Client API Documentation"})}),"\n",(0,o.jsx)(t.li,{children:"REST API Documentation"}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"contributing",children:"Contributing guide"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"contributing-to-the-documentation",children:"Contributing to the Documentation"}),"\n",(0,o.jsxs)(t.p,{children:["Documentation is always a work in progress and we welcome both, qualitative and\ntechnical contributions, from the community. Make sure you look into the\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/documentation",children:"documentations GitHub repository"})," and\nunderstand the pre-requisites before you submit your first PR!"]}),"\n",(0,o.jsx)(t.h2,{id:"about-us",children:"About Us"}),"\n",(0,o.jsxs)(t.p,{children:["Learn more about the brilliant minds pioneering the development and maintenance\nof Rucio in this section. Should you wish to get in touch with us, we've also\nincluded several ways of doing so in the ",(0,o.jsx)(t.strong,{children:"Contact Us"})," section."]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/project_organisation",children:"Project Organisation"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/about_our_contributors",children:"About Our Contributors"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/contact_us",children:"Contact Us"})}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var i=n(96540);const o={},s=i.createContext(o);function r(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/03a88bad.ee5f027b.js b/assets/js/03a88bad.ee5f027b.js new file mode 100644 index 0000000000..dffab1a9ce --- /dev/null +++ b/assets/js/03a88bad.ee5f027b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8078],{57699:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"index","title":"Welcome to Rucio\'s documentation","description":"Rucio is a project that provides services and associated libraries for allowing","source":"@site/../docs/index.md","sourceDirName":".","slug":"/","permalink":"/documentation/","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/index.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"index","title":"Welcome to Rucio\'s documentation","sidebar_label":"Welcome","slug":"/"},"sidebar":"docs","next":{"title":"Before you get started","permalink":"/documentation/started/before_you_get_started"}}');var o=n(74848),s=n(28453);const r={id:"index",title:"Welcome to Rucio's documentation",sidebar_label:"Welcome",slug:"/"},a=void 0,c={},l=[{value:"Getting Started",id:"getting-started",level:2},{value:"Client",id:"client",level:2},{value:"Administration",id:"administration",level:2},{value:"Developer Documentation",id:"developer-documentation",level:2},{value:"Contributing to the Documentation",id:"contributing-to-the-documentation",level:2},{value:"About Us",id:"about-us",level:2}];function d(e){const t={a:"a",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(t.p,{children:["Rucio is a project that provides services and associated libraries for allowing\nscientific collaborations to manage large volumes of data spread across\nfacilities at multiple institutions and organisations. Rucio was originally\ndeveloped to meet the requirements of the high-energy physics experiment\n",(0,o.jsx)(t.a,{href:"https://atlas.cern/",children:"ATLAS"}),", and now is continuously extended to support the\nLHC experiments and other diverse scientific communities."]}),"\n",(0,o.jsx)(t.p,{children:"Rucio offers advanced features, is highly scalable, and modular. It is a data\nmanagement solution that covers the needs of different communities in the\nscientific domain (e.g., HEP, astronomy, biology)."}),"\n",(0,o.jsx)(t.p,{children:"Below are some resources to help you get you started on your journey."}),"\n",(0,o.jsx)(t.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,o.jsx)(t.p,{children:"What exactly is Rucio? What were the motivations behind developing such a\nsystem? Who uses it? What powers these systems? Answers to all these questions\nand more can be found by browsing through the sub-sections of this topic."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/what_is_rucio",children:"What is Rucio"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/main_components",children:"Main Components"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/started/additional_layers_and_resources",children:"Additional Layers and Resources"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"client",children:"Client"}),"\n",(0,o.jsx)(t.p,{children:"The rucio client enables users to interact with the system and access the\ndistributed data. The client can upload, download, manage and delete everything\nfrom single files up to Petabyte sized datasets."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/setting_up_the_rucio_client",children:"Setting Up the Rucio Client"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/using_the_client",children:"Using the Client"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/user/using_the_admin_client",children:"Using the Admin Client"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"administration",children:"Administration"}),"\n",(0,o.jsx)(t.p,{children:"This section of the documentation deals with some of the material that an\noperator or administrator of a Rucio environment would require. For example, how\nto install a server or some quick tips for working with the administrative\nCLI. Take a deep dive, but not before you ensure you've read through the\npre-requisites section under each of the topics!"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/setting_up_demo",children:"Setting up a Rucio demo environment"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/installing_server",children:"Installing Rucio Server"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/installing_daemons",children:"Installing Rucio Daemons"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/monitoring",children:"Monitoring"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"operator/database",children:"Database"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/operator/configuration_parameters",children:"Configuration parameters"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"developer-documentation",children:"Developer Documentation"}),"\n",(0,o.jsx)(t.p,{children:"Whether you want to develop with Rucio or contribute to the project, the\nDeveloper documentation will help you get started. Peruse some common REST API &\nClient API references that are directly derived from Rucio's python\nlibraries. We also have a contribution guide for those who wish to pitch in."}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"pathname:///html/site/client.html",children:"Client API Documentation"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"pathname:///html/rest_api_doc.html",children:"REST API Documentation"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"contributing",children:"Contributing guide"})}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"contributing-to-the-documentation",children:"Contributing to the Documentation"}),"\n",(0,o.jsxs)(t.p,{children:["Documentation is always a work in progress and we welcome both, qualitative and\ntechnical contributions, from the community. Make sure you look into the\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/documentation",children:"documentations GitHub repository"})," and\nunderstand the pre-requisites before you submit your first PR!"]}),"\n",(0,o.jsx)(t.h2,{id:"about-us",children:"About Us"}),"\n",(0,o.jsxs)(t.p,{children:["Learn more about the brilliant minds pioneering the development and maintenance\nof Rucio in this section. Should you wish to get in touch with us, we've also\nincluded several ways of doing so in the ",(0,o.jsx)(t.strong,{children:"Contact Us"})," section."]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/project_organisation",children:"Project Organisation"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/about_our_contributors",children:"About Our Contributors"})}),"\n",(0,o.jsx)(t.li,{children:(0,o.jsx)(t.a,{href:"/documentation/contact_us",children:"Contact Us"})}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var i=n(96540);const o={},s=i.createContext(o);function r(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/093ddf2f.02d2fb91.js b/assets/js/093ddf2f.02d2fb91.js deleted file mode 100644 index aa16667f2e..0000000000 --- a/assets/js/093ddf2f.02d2fb91.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2985],{14817:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"special_interest_groups","title":"Special Interest Groups","description":"Rucio Special Interest Groups (SIG) serve the purpose to offer a forum for interested users,","source":"@site/../docs/special_interest_groups.md","sourceDirName":".","slug":"/special_interest_groups","permalink":"/documentation/special_interest_groups","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/special_interest_groups.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"special_interest_groups","title":"Special Interest Groups"},"sidebar":"docs","previous":{"title":"Component leads","permalink":"/documentation/component_leads"},"next":{"title":"About Our Contributors","permalink":"/documentation/about_our_contributors"}}');var s=n(74848),i=n(28453);const o={id:"special_interest_groups",title:"Special Interest Groups"},c=void 0,l={},a=[{value:"Structure",id:"structure",level:2},{value:"Current Special Interest Groups",id:"current-special-interest-groups",level:2},{value:"Past Special Interest Groups",id:"past-special-interest-groups",level:2}];function d(e){const t={a:"a",h2:"h2",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Rucio Special Interest Groups (SIG) serve the purpose to offer a forum for interested users,\noperators, and developers to discuss and plan the evolution of a specific part of Rucio.\nThe topic of a SIG needs to be well-defined and the community interest on the topic\nneeds to be above a threshold to justify the creation of a SIG, instead of covering the\ntopic just within the weekly Rucio meeting. A SIG topic can involve one or multiple\nRucio components, or even the entire system. SIGs are open to any interrested community\nmember."}),"\n",(0,s.jsx)(t.h2,{id:"structure",children:"Structure"}),"\n",(0,s.jsx)(t.p,{children:"Each SIG must define"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"A well-defined objective of the group (Creation of a report, Development of\na functionality, ...)"}),"\n",(0,s.jsx)(t.li,{children:"An expected end-date"}),"\n",(0,s.jsx)(t.li,{children:"Means to achieve the objective, such as regular meetings, a mailing-list, mattermost\nchannel, a workshop, ..."}),"\n",(0,s.jsx)(t.li,{children:"A convener"}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"current-special-interest-groups",children:"Current Special Interest Groups"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Start"}),(0,s.jsx)(t.th,{children:"est. End"}),(0,s.jsx)(t.th,{children:"Convener"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_metadata",children:"Metadata"})}),(0,s.jsx)(t.td,{children:"Jul-2021"}),(0,s.jsx)(t.td,{children:"Dec-2024"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://github.com/robbarnsley",children:"Rob Barnsley"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_tokens",children:"Tokens"})}),(0,s.jsx)(t.td,{children:"Sep-2023"}),(0,s.jsx)(t.td,{children:"Mar-2026"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://github.com/dchristidis",children:"Dimitrios Christidis"})})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"past-special-interest-groups",children:"Past Special Interest Groups"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Start"}),(0,s.jsx)(t.th,{children:"End"}),(0,s.jsx)(t.th,{children:"Convener"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_qualityofservice",children:"Quality of Service"})}),(0,s.jsx)(t.td,{children:"Jul-2021"}),(0,s.jsx)(t.td,{children:"Dec-2023"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"mailto:douglas.benjamin@cern.ch",children:"Doug Benjamin"})})]})})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(96540);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/093ddf2f.8e125a27.js b/assets/js/093ddf2f.8e125a27.js new file mode 100644 index 0000000000..70d7dd072f --- /dev/null +++ b/assets/js/093ddf2f.8e125a27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2985],{14817:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"special_interest_groups","title":"Special Interest Groups","description":"Rucio Special Interest Groups (SIG) serve the purpose to offer a forum for interested users,","source":"@site/../docs/special_interest_groups.md","sourceDirName":".","slug":"/special_interest_groups","permalink":"/documentation/special_interest_groups","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/special_interest_groups.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"special_interest_groups","title":"Special Interest Groups"},"sidebar":"docs","previous":{"title":"Component leads","permalink":"/documentation/component_leads"},"next":{"title":"About Our Contributors","permalink":"/documentation/about_our_contributors"}}');var s=n(74848),i=n(28453);const o={id:"special_interest_groups",title:"Special Interest Groups"},c=void 0,l={},d=[{value:"Structure",id:"structure",level:2},{value:"Current Special Interest Groups",id:"current-special-interest-groups",level:2},{value:"Past Special Interest Groups",id:"past-special-interest-groups",level:2}];function a(e){const t={a:"a",h2:"h2",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Rucio Special Interest Groups (SIG) serve the purpose to offer a forum for interested users,\noperators, and developers to discuss and plan the evolution of a specific part of Rucio.\nThe topic of a SIG needs to be well-defined and the community interest on the topic\nneeds to be above a threshold to justify the creation of a SIG, instead of covering the\ntopic just within the weekly Rucio meeting. A SIG topic can involve one or multiple\nRucio components, or even the entire system. SIGs are open to any interrested community\nmember."}),"\n",(0,s.jsx)(t.h2,{id:"structure",children:"Structure"}),"\n",(0,s.jsx)(t.p,{children:"Each SIG must define"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"A well-defined objective of the group (Creation of a report, Development of\na functionality, ...)"}),"\n",(0,s.jsx)(t.li,{children:"An expected end-date"}),"\n",(0,s.jsx)(t.li,{children:"Means to achieve the objective, such as regular meetings, a mailing-list, mattermost\nchannel, a workshop, ..."}),"\n",(0,s.jsx)(t.li,{children:"A convener"}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"current-special-interest-groups",children:"Current Special Interest Groups"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Start"}),(0,s.jsx)(t.th,{children:"est. End"}),(0,s.jsx)(t.th,{children:"Convener"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_metadata",children:"Metadata"})}),(0,s.jsx)(t.td,{children:"Jul-2021"}),(0,s.jsx)(t.td,{children:"Dec-2024"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://github.com/robbarnsley",children:"Rob Barnsley"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_tokens",children:"Tokens"})}),(0,s.jsx)(t.td,{children:"Sep-2023"}),(0,s.jsx)(t.td,{children:"Mar-2026"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"https://github.com/dchristidis",children:"Dimitrios Christidis"})})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"past-special-interest-groups",children:"Past Special Interest Groups"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Name"}),(0,s.jsx)(t.th,{children:"Start"}),(0,s.jsx)(t.th,{children:"End"}),(0,s.jsx)(t.th,{children:"Convener"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/documentation/sig_qualityofservice",children:"Quality of Service"})}),(0,s.jsx)(t.td,{children:"Jul-2021"}),(0,s.jsx)(t.td,{children:"Dec-2023"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"mailto:douglas.benjamin@cern.ch",children:"Doug Benjamin"})})]})})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(96540);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0aef9821.69e63d6b.js b/assets/js/0aef9821.69e63d6b.js new file mode 100644 index 0000000000..3d16fc5d36 --- /dev/null +++ b/assets/js/0aef9821.69e63d6b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[3103],{51602:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"started/concepts/rucio_storage_element","title":"Rucio Storage Element","description":"A Rucio Storage Element (RSE) is the logical abstraction of a storage system for","source":"@site/../docs/started/concepts/rucio_storage_element.md","sourceDirName":"started/concepts","slug":"/started/concepts/rucio_storage_element","permalink":"/documentation/started/concepts/rucio_storage_element","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/rucio_storage_element.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"title":"Rucio Storage Element"},"sidebar":"docs","previous":{"title":"Files, Datasets, and Containers","permalink":"/documentation/started/concepts/file_dataset_container"},"next":{"title":"Metadata attributes","permalink":"/documentation/started/concepts/metadata_attributes"}}');var a=n(74848),o=n(28453);const i={title:"Rucio Storage Element"},r=void 0,c={},l=[{value:"Rucio Cache RSE",id:"rucio-cache-rse",level:2},{value:"Distances between RSEs",id:"distances-between-rses",level:2}];function d(e){const t={a:"a",h2:"h2",p:"p",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"A Rucio Storage Element (RSE) is the logical abstraction of a storage system for\nphysical files. It is the smallest unit of storage space addressable within\nRucio. It has a unique identifier and a set of meta attributes describing\nproperties such as supported protocols (https, srm, s3, ...), host/port\naddress, quality of service, storage type (disk, tape, ...), physical space\nproperties (used-, available-, non-pledged space), and geographical zone."}),"\n",(0,a.jsxs)(t.p,{children:["Rucio Storage Elements can be grouped in many logical ways, e.g. the UK RSEs,\nthe Tier-1 RSEs, or the 'good' RSEs. One can reference groups of RSEs by\nmetadata attributes or by explicit enumeration of RSEs. See the section about\n",(0,a.jsx)(t.a,{href:"/documentation/started/concepts/rse_expressions",children:"RSE Expressions"})," for more information."]}),"\n",(0,a.jsx)(t.p,{children:"RSE tags are expanded at transfer time to enumerate target sites. Post-facto\nchanges to the sites in an RSE tag list will not affect currently replicated\nfiles."}),"\n",(0,a.jsx)(t.h2,{id:"rucio-cache-rse",children:"Rucio Cache RSE"}),"\n",(0,a.jsxs)(t.p,{children:["A cache is storage service which keeps additional copies of files to reduce\nresponse time and bandwidth usage. In Rucio, a cache is an RSE, tagged as\nvolatile. The control of the cache content is usually handled by an external\nprocess or applications (e.g. the Workflow management systems) and not by\nRucio. Thus, as Rucio doesn't control all file movements on these RSEs, the\napplication populating the cache must register and unregister these file\nreplicas in Rucio. The information about replica location on volatile RSEs can\nhave a lifetime. Replicas registered on volatile RSEs are excluded from the\nRucio replica management system (replication rules, quota, replication locks)\ndescribed in the section ",(0,a.jsx)(t.a,{href:"/documentation/started/concepts/replica_management",children:"Replica management"}),". Explicit\ntransfer requests can be made to Rucio in order to populate the cache."]}),"\n",(0,a.jsx)(t.h2,{id:"distances-between-rses",children:"Distances between RSEs"}),"\n",(0,a.jsxs)(t.p,{children:["When configuring transfers between RSEs, distances must be defined for that link.\nDistances are unidirectional. To allow transfers in both directions, a distance\nhas to be defined separately in each direction. Refer to the section\n",(0,a.jsx)(t.a,{href:"/documentation/operator/transfers/transfers-overview",children:"Transfers Overview"})," for more details."]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>r});var s=n(96540);const a={},o=s.createContext(a);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0aef9821.e66124bf.js b/assets/js/0aef9821.e66124bf.js deleted file mode 100644 index 61bfe36c2c..0000000000 --- a/assets/js/0aef9821.e66124bf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[3103],{51602:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"started/concepts/rucio_storage_element","title":"Rucio Storage Element","description":"A Rucio Storage Element (RSE) is the logical abstraction of a storage system for","source":"@site/../docs/started/concepts/rucio_storage_element.md","sourceDirName":"started/concepts","slug":"/started/concepts/rucio_storage_element","permalink":"/documentation/started/concepts/rucio_storage_element","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/rucio_storage_element.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"title":"Rucio Storage Element"},"sidebar":"docs","previous":{"title":"Files, Datasets, and Containers","permalink":"/documentation/started/concepts/file_dataset_container"},"next":{"title":"Metadata attributes","permalink":"/documentation/started/concepts/metadata_attributes"}}');var a=n(74848),o=n(28453);const i={title:"Rucio Storage Element"},r=void 0,c={},l=[{value:"Rucio Cache RSE",id:"rucio-cache-rse",level:2},{value:"Distances between RSEs",id:"distances-between-rses",level:2}];function d(e){const t={a:"a",h2:"h2",p:"p",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"A Rucio Storage Element (RSE) is the logical abstraction of a storage system for\nphysical files. It is the smallest unit of storage space addressable within\nRucio. It has a unique identifier and a set of meta attributes describing\nproperties such as supported protocols (https, srm, s3, ...), host/port\naddress, quality of service, storage type (disk, tape, ...), physical space\nproperties (used-, available-, non-pledged space), and geographical zone."}),"\n",(0,a.jsxs)(t.p,{children:["Rucio Storage Elements can be grouped in many logical ways, e.g. the UK RSEs,\nthe Tier-1 RSEs, or the 'good' RSEs. One can reference groups of RSEs by\nmetadata attributes or by explicit enumeration of RSEs. See the section about\n",(0,a.jsx)(t.a,{href:"/documentation/started/concepts/rse_expressions",children:"RSE Expressions"})," for more information."]}),"\n",(0,a.jsx)(t.p,{children:"RSE tags are expanded at transfer time to enumerate target sites. Post-facto\nchanges to the sites in an RSE tag list will not affect currently replicated\nfiles."}),"\n",(0,a.jsx)(t.h2,{id:"rucio-cache-rse",children:"Rucio Cache RSE"}),"\n",(0,a.jsxs)(t.p,{children:["A cache is storage service which keeps additional copies of files to reduce\nresponse time and bandwidth usage. In Rucio, a cache is an RSE, tagged as\nvolatile. The control of the cache content is usually handled by an external\nprocess or applications (e.g. the Workflow management systems) and not by\nRucio. Thus, as Rucio doesn't control all file movements on these RSEs, the\napplication populating the cache must register and unregister these file\nreplicas in Rucio. The information about replica location on volatile RSEs can\nhave a lifetime. Replicas registered on volatile RSEs are excluded from the\nRucio replica management system (replication rules, quota, replication locks)\ndescribed in the section ",(0,a.jsx)(t.a,{href:"/documentation/started/concepts/replica_management",children:"Replica management"}),". Explicit\ntransfer requests can be made to Rucio in order to populate the cache."]}),"\n",(0,a.jsx)(t.h2,{id:"distances-between-rses",children:"Distances between RSEs"}),"\n",(0,a.jsxs)(t.p,{children:["When configuring transfers between RSEs, distances must be defined for that link.\nDistances are unidirectional. To allow transfers in both directions, a distance\nhas to be defined separately in each direction. Refer to the section\n",(0,a.jsx)(t.a,{href:"/documentation/operator/transfers/transfers-overview",children:"Transfers Overview"})," for more details."]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>r});var s=n(96540);const a={},o=s.createContext(a);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c78ace3.4fff1d40.js b/assets/js/0c78ace3.4fff1d40.js deleted file mode 100644 index d0adf7404a..0000000000 --- a/assets/js/0c78ace3.4fff1d40.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4885],{94178:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"developer/webui/webui_frontend_vscode_dev_env","title":"Setting up a WebUI Developer Environment using Visual Studio Code","description":"Different Usecases","source":"@site/../docs/developer/webui/webui_frontend_vscode_dev_env.md","sourceDirName":"developer/webui","slug":"/developer/webui/webui_frontend_vscode_dev_env","permalink":"/documentation/developer/webui/webui_frontend_vscode_dev_env","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/webui/webui_frontend_vscode_dev_env.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"webui_frontend_vscode_dev_env","title":"Setting up a WebUI Developer Environment using Visual Studio Code"},"sidebar":"docs","previous":{"title":"Style Guide","permalink":"/documentation/developer/dev_style_guide"},"next":{"title":"Using the WebUI StreamedTable Component","permalink":"/documentation/developer/webui/streamedtables"}}');var i=o(74848),s=o(28453);const r={id:"webui_frontend_vscode_dev_env",title:"Setting up a WebUI Developer Environment using Visual Studio Code"},c=void 0,d={},l=[{value:"Different Usecases",id:"different-usecases",level:2},{value:"UI Only",id:"ui-only",level:2},{value:"Connecting to a Rucio instance",id:"connecting-to-a-rucio-instance",level:2}];function a(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"different-usecases",children:"Different Usecases"}),"\n",(0,i.jsx)(n.p,{children:"There are different usecases when developing for the WebUI, this leads to\nvarying requirements for the development environment. This guide will cover two\nusecases:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"UI development only (i.e. using Storybook)."}),"\n",(0,i.jsx)(n.li,{children:"Full WebUI development, requiring the connection to a Rucio server."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'In both cases, the proposed development environment is run fully local. Visual\nStudio Code is more than just an editor, and we attempt to make use of its "Dev\nContainer"-tooling as much as possible.'}),"\n",(0,i.jsx)(n.h2,{id:"ui-only",children:"UI Only"}),"\n",(0,i.jsxs)(n.p,{children:["Remember that the WebUI frontend is composed of ",(0,i.jsx)(n.em,{children:"Components"}),", which are\ndeveloped with the help of a tool called ",(0,i.jsx)(n.a,{href:"https://storybook.js.org/",children:"Storybook"}),'.\nStorybook is, in its own words, a "frontend workshop for building UI components\nand pages in isolation". To us, it is a viewer which allows us to inspect\nindividual components and interactively manipulate the inputs to these\ncomponents. An example would be viewing a clickable button and manipulating the\n"disabled" attribute, noticing that the colour changes from blue to gray, etc.\nStorybook is also very helpful when testing accessibility and design.']}),"\n",(0,i.jsxs)(n.p,{children:["For a developer whose only intent is to add to or edit these components (found\nunder ",(0,i.jsx)(n.code,{children:"webui/src/component-library"}),"), it is helpful to run a docker container\nwith NPM and TypeScript."]}),"\n",(0,i.jsxs)(n.p,{children:["Open the editor commands with ",(0,i.jsx)(n.code,{children:"Ctrl"}),"-",(0,i.jsx)(n.code,{children:"Shift"}),"-",(0,i.jsx)(n.code,{children:"P"})," and run ",(0,i.jsx)(n.code,{children:"Dev containers: reopen in dev container"}),". Select ",(0,i.jsx)(n.code,{children:"Node.js & Typescript"})," in the follow-up menu. Go with\nthe default values in the following menus."]}),"\n",(0,i.jsxs)(n.p,{children:["You can close the remote connection via the editor commands. From now on, you\ncan reopen the same dev container by opening the folder locally and selecting\n",(0,i.jsx)(n.code,{children:"reopen in dev container"})," from the editor commands. You can also directly open\nthe folder in the dev container, for example using ",(0,i.jsx)(n.code,{children:"File"})," > ",(0,i.jsx)(n.code,{children:"Open Recent"})," and\nthen selecting an element such as ",(0,i.jsx)(n.code,{children:"~/foo/bar [Dev Container]"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"It makes sense to install some extensions for a better dev experience:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Tailwind CSS Intellisense"}),"\n",(0,i.jsx)(n.li,{children:"ESLint"}),"\n",(0,i.jsx)(n.li,{children:"Jest"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"These extensions are specific to the project at hand. Of course, extensions such\nas Github Copilot and GitLens are still helpful."}),"\n",(0,i.jsxs)(n.p,{children:["An further extension that is extremely important is ",(0,i.jsx)(n.em,{children:"Run on Save"})," by\nemeraldwalk. This will need to be configured: enter the settings with ",(0,i.jsx)(n.code,{children:"Ctrl"}),"-",(0,i.jsx)(n.code,{children:","}),"\nand search ",(0,i.jsx)(n.code,{children:"Emeraldwalk: Runonsave"}),". Click on ",(0,i.jsx)(n.code,{children:"Edit in settings.json"}),". Add the\nfollowing configuration:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'"emeraldwalk.runonsave": {\n "commands": [\n {\n "match": "\\\\.tsx$",\n "cmd": "npm run build-tailwind"\n }\n ]\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["to ensure that the ",(0,i.jsx)(n.code,{children:"build-tailwind"})," command will be run each time you save a\n",(0,i.jsx)(n.code,{children:"*.tsx"})," file."]}),"\n",(0,i.jsxs)(n.p,{children:["You can now run Storybook using ",(0,i.jsx)(n.code,{children:"npm run storybook"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"connecting-to-a-rucio-instance",children:"Connecting to a Rucio instance"}),"\n",(0,i.jsx)(n.p,{children:"When testing the full WebUI stack, it will be necessary to connect to a Rucio\nbackend. This can be done by running a Rucio instance locally."}),"\n",(0,i.jsx)(n.p,{children:"We begin by starting all the Docker containers required."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Start the dev container as described above."}),"\n",(0,i.jsxs)(n.li,{children:["Clone Rucio from the ",(0,i.jsx)(n.a,{href:"https://github.com/rucio/rucio",children:"Github Repository"})]}),"\n",(0,i.jsx)(n.li,{children:"Open the folder in VS Code."}),"\n",(0,i.jsxs)(n.li,{children:["Open the editor commands and run ",(0,i.jsx)(n.code,{children:"Docker Compose Up"})," and select\n",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["Starting the docker containers using ",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"})," will also\ncreate several RSEs, DIDs, etc. on the rucio instance which are quite helpful\nwhen running tests."]})}),"\n",(0,i.jsx)(n.p,{children:"We must now connect the dev container to the rucio container network."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Figure out the docker name of the dev container. Run ",(0,i.jsx)(n.code,{children:"docker ps"})," and search\nfor name which does not contain the string ",(0,i.jsx)(n.code,{children:"rucio"})]}),"\n",(0,i.jsxs)(n.li,{children:["Connect using ",(0,i.jsx)(n.code,{children:"docker network connect dev_default "}),".\n",(0,i.jsx)(n.code,{children:"dev_default"})," is the name of the network shared by the docker containers spun\nup using ",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"})," from earlier."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Finally, we must change the ",(0,i.jsx)(n.code,{children:"RUCIO_AUTH_HOST"})," and ",(0,i.jsx)(n.code,{children:"RUCIO_HOST"})," in the\n",(0,i.jsx)(n.code,{children:".env.development.local"})," file at the root level of the WebUI repository to point\nto the rucio container. By default, this should be ",(0,i.jsx)(n.code,{children:"https://dev-rucio-1:443"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Test the setup by logging in using the credentials username ",(0,i.jsx)(n.code,{children:"ddmlab"}),"/ password\n",(0,i.jsx)(n.code,{children:"secret"}),"/ account ",(0,i.jsx)(n.code,{children:"root"})," under the VO ",(0,i.jsx)(n.code,{children:"Default"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,n,o)=>{o.d(n,{R:()=>r,x:()=>c});var t=o(96540);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c78ace3.9305b364.js b/assets/js/0c78ace3.9305b364.js new file mode 100644 index 0000000000..43ee33a716 --- /dev/null +++ b/assets/js/0c78ace3.9305b364.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4885],{94178:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"developer/webui/webui_frontend_vscode_dev_env","title":"Setting up a WebUI Developer Environment using Visual Studio Code","description":"Different Usecases","source":"@site/../docs/developer/webui/webui_frontend_vscode_dev_env.md","sourceDirName":"developer/webui","slug":"/developer/webui/webui_frontend_vscode_dev_env","permalink":"/documentation/developer/webui/webui_frontend_vscode_dev_env","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/webui/webui_frontend_vscode_dev_env.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"webui_frontend_vscode_dev_env","title":"Setting up a WebUI Developer Environment using Visual Studio Code"},"sidebar":"docs","previous":{"title":"Style Guide","permalink":"/documentation/developer/dev_style_guide"},"next":{"title":"Using the WebUI StreamedTable Component","permalink":"/documentation/developer/webui/streamedtables"}}');var i=o(74848),s=o(28453);const r={id:"webui_frontend_vscode_dev_env",title:"Setting up a WebUI Developer Environment using Visual Studio Code"},c=void 0,d={},l=[{value:"Different Usecases",id:"different-usecases",level:2},{value:"UI Only",id:"ui-only",level:2},{value:"Connecting to a Rucio instance",id:"connecting-to-a-rucio-instance",level:2}];function a(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"different-usecases",children:"Different Usecases"}),"\n",(0,i.jsx)(n.p,{children:"There are different usecases when developing for the WebUI, this leads to\nvarying requirements for the development environment. This guide will cover two\nusecases:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"UI development only (i.e. using Storybook)."}),"\n",(0,i.jsx)(n.li,{children:"Full WebUI development, requiring the connection to a Rucio server."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'In both cases, the proposed development environment is run fully local. Visual\nStudio Code is more than just an editor, and we attempt to make use of its "Dev\nContainer"-tooling as much as possible.'}),"\n",(0,i.jsx)(n.h2,{id:"ui-only",children:"UI Only"}),"\n",(0,i.jsxs)(n.p,{children:["Remember that the WebUI frontend is composed of ",(0,i.jsx)(n.em,{children:"Components"}),", which are\ndeveloped with the help of a tool called ",(0,i.jsx)(n.a,{href:"https://storybook.js.org/",children:"Storybook"}),'.\nStorybook is, in its own words, a "frontend workshop for building UI components\nand pages in isolation". To us, it is a viewer which allows us to inspect\nindividual components and interactively manipulate the inputs to these\ncomponents. An example would be viewing a clickable button and manipulating the\n"disabled" attribute, noticing that the colour changes from blue to gray, etc.\nStorybook is also very helpful when testing accessibility and design.']}),"\n",(0,i.jsxs)(n.p,{children:["For a developer whose only intent is to add to or edit these components (found\nunder ",(0,i.jsx)(n.code,{children:"webui/src/component-library"}),"), it is helpful to run a docker container\nwith NPM and TypeScript."]}),"\n",(0,i.jsxs)(n.p,{children:["Open the editor commands with ",(0,i.jsx)(n.code,{children:"Ctrl"}),"-",(0,i.jsx)(n.code,{children:"Shift"}),"-",(0,i.jsx)(n.code,{children:"P"})," and run ",(0,i.jsx)(n.code,{children:"Dev containers: reopen in dev container"}),". Select ",(0,i.jsx)(n.code,{children:"Node.js & Typescript"})," in the follow-up menu. Go with\nthe default values in the following menus."]}),"\n",(0,i.jsxs)(n.p,{children:["You can close the remote connection via the editor commands. From now on, you\ncan reopen the same dev container by opening the folder locally and selecting\n",(0,i.jsx)(n.code,{children:"reopen in dev container"})," from the editor commands. You can also directly open\nthe folder in the dev container, for example using ",(0,i.jsx)(n.code,{children:"File"})," > ",(0,i.jsx)(n.code,{children:"Open Recent"})," and\nthen selecting an element such as ",(0,i.jsx)(n.code,{children:"~/foo/bar [Dev Container]"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"It makes sense to install some extensions for a better dev experience:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Tailwind CSS Intellisense"}),"\n",(0,i.jsx)(n.li,{children:"ESLint"}),"\n",(0,i.jsx)(n.li,{children:"Jest"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"These extensions are specific to the project at hand. Of course, extensions such\nas Github Copilot and GitLens are still helpful."}),"\n",(0,i.jsxs)(n.p,{children:["An further extension that is extremely important is ",(0,i.jsx)(n.em,{children:"Run on Save"})," by\nemeraldwalk. This will need to be configured: enter the settings with ",(0,i.jsx)(n.code,{children:"Ctrl"}),"-",(0,i.jsx)(n.code,{children:","}),"\nand search ",(0,i.jsx)(n.code,{children:"Emeraldwalk: Runonsave"}),". Click on ",(0,i.jsx)(n.code,{children:"Edit in settings.json"}),". Add the\nfollowing configuration:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'"emeraldwalk.runonsave": {\n "commands": [\n {\n "match": "\\\\.tsx$",\n "cmd": "npm run build-tailwind"\n }\n ]\n}\n'})}),"\n",(0,i.jsxs)(n.p,{children:["to ensure that the ",(0,i.jsx)(n.code,{children:"build-tailwind"})," command will be run each time you save a\n",(0,i.jsx)(n.code,{children:"*.tsx"})," file."]}),"\n",(0,i.jsxs)(n.p,{children:["You can now run Storybook using ",(0,i.jsx)(n.code,{children:"npm run storybook"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"connecting-to-a-rucio-instance",children:"Connecting to a Rucio instance"}),"\n",(0,i.jsx)(n.p,{children:"When testing the full WebUI stack, it will be necessary to connect to a Rucio\nbackend. This can be done by running a Rucio instance locally."}),"\n",(0,i.jsx)(n.p,{children:"We begin by starting all the Docker containers required."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"Start the dev container as described above."}),"\n",(0,i.jsxs)(n.li,{children:["Clone Rucio from the ",(0,i.jsx)(n.a,{href:"https://github.com/rucio/rucio",children:"Github Repository"})]}),"\n",(0,i.jsx)(n.li,{children:"Open the folder in VS Code."}),"\n",(0,i.jsxs)(n.li,{children:["Open the editor commands and run ",(0,i.jsx)(n.code,{children:"Docker Compose Up"})," and select\n",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["Starting the docker containers using ",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"})," will also\ncreate several RSEs, DIDs, etc. on the rucio instance which are quite helpful\nwhen running tests."]})}),"\n",(0,i.jsx)(n.p,{children:"We must now connect the dev container to the rucio container network."}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Figure out the docker name of the dev container. Run ",(0,i.jsx)(n.code,{children:"docker ps"})," and search\nfor name which does not contain the string ",(0,i.jsx)(n.code,{children:"rucio"})]}),"\n",(0,i.jsxs)(n.li,{children:["Connect using ",(0,i.jsx)(n.code,{children:"docker network connect dev_default "}),".\n",(0,i.jsx)(n.code,{children:"dev_default"})," is the name of the network shared by the docker containers spun\nup using ",(0,i.jsx)(n.code,{children:"docker-compose-storage.yml"})," from earlier."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Finally, we must change the ",(0,i.jsx)(n.code,{children:"RUCIO_AUTH_HOST"})," and ",(0,i.jsx)(n.code,{children:"RUCIO_HOST"})," in the\n",(0,i.jsx)(n.code,{children:".env.development.local"})," file at the root level of the WebUI repository to point\nto the rucio container. By default, this should be ",(0,i.jsx)(n.code,{children:"https://dev-rucio-1:443"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["Test the setup by logging in using the credentials username ",(0,i.jsx)(n.code,{children:"ddmlab"}),"/ password\n",(0,i.jsx)(n.code,{children:"secret"}),"/ account ",(0,i.jsx)(n.code,{children:"root"})," under the VO ",(0,i.jsx)(n.code,{children:"Default"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,n,o)=>{o.d(n,{R:()=>r,x:()=>c});var t=o(96540);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/102869dc.a9f8eff7.js b/assets/js/102869dc.a9f8eff7.js deleted file mode 100644 index baa5aaf961..0000000000 --- a/assets/js/102869dc.a9f8eff7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[342],{77006:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"client_api/exportclient","title":"ExportClient","description":"export\\\\_data","source":"@site/../docs/client_api/exportclient.md","sourceDirName":"client_api","slug":"/client_api/exportclient","permalink":"/documentation/client_api/exportclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/exportclient.md","tags":[],"version":"current","frontMatter":{"title":"ExportClient"},"sidebar":"docs","previous":{"title":"DownloadClient","permalink":"/documentation/client_api/downloadclient"},"next":{"title":"FileClient","permalink":"/documentation/client_api/fileclient"}}');var r=n(74848),i=n(28453);const c={title:"ExportClient"},l=void 0,s={},d=[{value:"export_data",id:"export_data",level:2}];function a(e){const t={code:"code",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"export_data",children:"export_data"}),"\n",(0,r.jsxs)("span",{style:{"white-space":"pre"},children:[(0,r.jsx)(t.p,{children:"Export RSE data (RSE, settings, attributes and distance)."}),(0,r.jsx)("table",{style:{border:"none"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{style:{border:"none"},children:[(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Arguments"}),":"]})}),(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"distance"}),": To include the distance."]})})]}),(0,r.jsxs)("tr",{style:{border:"none"},children:[(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Returns"}),":"]})}),(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsx)(t.p,{children:"A dict containing data"})})]})]})})]})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>l});var o=n(96540);const r={},i=o.createContext(r);function c(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1220bf94.2dbbe57e.js b/assets/js/1220bf94.2dbbe57e.js new file mode 100644 index 0000000000..76f655e92c --- /dev/null +++ b/assets/js/1220bf94.2dbbe57e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2815],{8805:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"started/concepts/replica_workflow","title":"Typical Replica Workflow","description":"This section gives an overview of what happens within Rucio, for a typical","source":"@site/../docs/started/concepts/replica_workflow.md","sourceDirName":"started/concepts","slug":"/started/concepts/replica_workflow","permalink":"/documentation/started/concepts/replica_workflow","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/replica_workflow.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"replica_workflow","title":"Typical Replica Workflow"},"sidebar":"docs","previous":{"title":"Subscriptions","permalink":"/documentation/started/concepts/subscriptions"},"next":{"title":"Release Policy","permalink":"/documentation/started/releasepolicy"}}');var s=i(74848),a=i(28453);const r={id:"replica_workflow",title:"Typical Replica Workflow"},o=void 0,c={},d=[{value:"Replica paths on storage",id:"replica-paths-on-storage",level:2},{value:"Deterministic algorithm based on hashes",id:"deterministic-algorithm-based-on-hashes",level:2},{value:"Deterministic algorithm based on naming convention",id:"deterministic-algorithm-based-on-naming-convention",level:2},{value:"Non-Deterministic algorithm based on parent dataset",id:"non-deterministic-algorithm-based-on-parent-dataset",level:2},{value:"Replica is uploaded with the command line client",id:"replica-is-uploaded-with-the-command-line-client",level:2},{value:"Replica is created by a replication rule",id:"replica-is-created-by-a-replication-rule",level:2}];function l(e){const t={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["This section gives an overview of what happens within Rucio, for a typical\nreplica workflow. Two workflows are described: When a replica is uploaded to\nRucio via a client and when a replica is created by a site to site transfer due\nto the creation of a ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/replica_management",children:"replication rule"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"replica-paths-on-storage",children:"Replica paths on storage"}),"\n",(0,s.jsxs)(t.p,{children:["Rucio has two basic paradigms in deciding the path for a replica on a specific\nstorage system. ",(0,s.jsx)(t.strong,{children:"Deterministic"})," and ",(0,s.jsx)(t.strong,{children:"Non-deterministic"})," paths. If we assume\na file whose data identifier is ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"}),", thus the scope is\n",(0,s.jsx)(t.code,{children:"user.jdoe"})," and the name is ",(0,s.jsx)(t.code,{children:"test.file.1"}),". In Rucio a deterministically created\npath is a path which can be generated solely knowing the scope and name of a\ndata identifier (Ignoring the static prefix of the storage endpoint). For a\nnon-deterministic path additional information describing the file is necessary,\nsuch as meta-data, the dataset the file belongs to, etc."]}),"\n",(0,s.jsx)(t.p,{children:"Rucio supports pluggable algorithms for both deterministic and non-deterministic\nalgorithms. This section explains a few of them."}),"\n",(0,s.jsx)(t.h2,{id:"deterministic-algorithm-based-on-hashes",children:"Deterministic algorithm based on hashes"}),"\n",(0,s.jsx)(t.p,{children:"The hash deterministic algorithm is an algorithm commonly used in Rucio. The\nadvantage of this algorithm is that, due to the characteristics of cryptographic\nhash functions, the files are evenly distributed to directories. This can be an\nimportant characteristic for storage systems whose access performance degrades\nbased on the number of files in a directory."}),"\n",(0,s.jsxs)(t.p,{children:["For a data identifier, e.g. ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," a md5-hashsum is calculated\n",(0,s.jsx)(t.code,{children:"077c8119053bebb168d125034bff64ac"}),". The generated path is then based on the\nfirst four characters of the hashsum. e.g. ",(0,s.jsx)(t.code,{children:"/user/jdoe/07/7c/test.file.1"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"deterministic-algorithm-based-on-naming-convention",children:"Deterministic algorithm based on naming convention"}),"\n",(0,s.jsx)(t.p,{children:"If a specific naming convention is enforced on the filenames, a possible\ndeterministic algorithm can be based on it."}),"\n",(0,s.jsxs)(t.p,{children:["For the data identifier ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," the first part of the filename\n(",(0,s.jsx)(t.code,{children:"test"}),") is extracted and used to generate the path: ",(0,s.jsx)(t.code,{children:"/test/user.jdoe/file.1"})]}),"\n",(0,s.jsx)(t.h2,{id:"non-deterministic-algorithm-based-on-parent-dataset",children:"Non-Deterministic algorithm based on parent dataset"}),"\n",(0,s.jsxs)(t.p,{children:["If the file is part of a dataset, e.g. ",(0,s.jsx)(t.code,{children:"data:dataset1234"})," the dataset can be\nused in the path of the filename. This is useful for e.g. tape storage systems,\nto keep the files belonging to the same dataset on the same tape."]}),"\n",(0,s.jsxs)(t.p,{children:["For the data identifier ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," which is part of the dataset\n",(0,s.jsx)(t.code,{children:"data:dataset1234"})," the generated path is:\n",(0,s.jsx)(t.code,{children:"/data/dataset1234/user.jdoe/test.file.1"})]}),"\n",(0,s.jsx)(t.h2,{id:"replica-is-uploaded-with-the-command-line-client",children:"Replica is uploaded with the command line client"}),"\n",(0,s.jsx)(t.p,{children:"This is a typical workflow when a user uploads multiple files, which are part of\na dataset, via the command line client."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The dataset ",(0,s.jsx)(t.code,{children:"test.dataset"})," is being registered at the server. All files, or\ndatasets are associated to a ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/file_dataset_container",children:"scope"}),", if not\nspecifically mentioned the client will assume the default scope of the user,\nsuch as ",(0,s.jsx)(t.code,{children:"user.jdoe"}),". Thus the full data identifier for the dataset is\n",(0,s.jsx)(t.code,{children:"user.jdoe:test.dataset"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The client queries the RSE information from the server. This not only gives a\nlist of prioritized write protocols to use but also the information if the\nRSE is a deterministic or non-deterministic one."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The file replica is registered as ",(0,s.jsx)(t.code,{children:"COPYING"})," on the RSE."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Based on the identified naming algorithm of the RSE and the list of\nprioritized write protocols, the file URL is calculated. e.g. using the hash\nalgorithm from above:\n",(0,s.jsx)(t.code,{children:"https://storageserver.organization.org/VO/data/user/jdoe/07/7c/test.file.1"})]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The file upload is done with the first prioritized protocol. If the upload\nfails, step 4 is repeated with the second prioritized protocol, etc."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Once the upload is successfully finished, the replica state is changed to\n",(0,s.jsx)(t.code,{children:"AVAILABLE"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Step 3-6 are repeated (done in parallel) with all other files part of the\nuploaded dataset."}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"replica-is-created-by-a-replication-rule",children:"Replica is created by a replication rule"}),"\n",(0,s.jsx)(t.p,{children:"This is a typical workflow if a file already exists in Rucio but the user wants\nto replicate it to a different RSE."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The user creates a replication rule for the dataset ",(0,s.jsx)(t.code,{children:"user.jdoe:test.dataset"}),"\nat the server."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The Rucio server creates internal requests for each single file in the\ndataset and puts them in a queue to be read by the data transfer service."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The data transfer submitter picks these requests up and queries the\ndestination RSE information for each file."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Based on the identified naming algorithm of the destination RSE it creates\nthe destination URLs and creates the file replicas in ",(0,s.jsx)(t.code,{children:"COPYING"})," state."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The transfer service then submits the transfer job to the connected transfer\ntool (e.g. FTS)"}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Once the transfers are finished the transfer tool notifies Rucio about the\ntransfer success and the transfer services mark the replicas as ",(0,s.jsx)(t.code,{children:"AVAILABLE"}),"."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>o});var n=i(96540);const s={},a=n.createContext(s);function r(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1220bf94.ffe35f3c.js b/assets/js/1220bf94.ffe35f3c.js deleted file mode 100644 index 4cc55c734a..0000000000 --- a/assets/js/1220bf94.ffe35f3c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2815],{8805:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"started/concepts/replica_workflow","title":"Typical Replica Workflow","description":"This section gives an overview of what happens within Rucio, for a typical","source":"@site/../docs/started/concepts/replica_workflow.md","sourceDirName":"started/concepts","slug":"/started/concepts/replica_workflow","permalink":"/documentation/started/concepts/replica_workflow","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/replica_workflow.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"replica_workflow","title":"Typical Replica Workflow"},"sidebar":"docs","previous":{"title":"Subscriptions","permalink":"/documentation/started/concepts/subscriptions"},"next":{"title":"Release Policy","permalink":"/documentation/started/releasepolicy"}}');var s=i(74848),a=i(28453);const r={id:"replica_workflow",title:"Typical Replica Workflow"},o=void 0,c={},d=[{value:"Replica paths on storage",id:"replica-paths-on-storage",level:2},{value:"Deterministic algorithm based on hashes",id:"deterministic-algorithm-based-on-hashes",level:2},{value:"Deterministic algorithm based on naming convention",id:"deterministic-algorithm-based-on-naming-convention",level:2},{value:"Non-Deterministic algorithm based on parent dataset",id:"non-deterministic-algorithm-based-on-parent-dataset",level:2},{value:"Replica is uploaded with the command line client",id:"replica-is-uploaded-with-the-command-line-client",level:2},{value:"Replica is created by a replication rule",id:"replica-is-created-by-a-replication-rule",level:2}];function l(e){const t={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["This section gives an overview of what happens within Rucio, for a typical\nreplica workflow. Two workflows are described: When a replica is uploaded to\nRucio via a client and when a replica is created by a site to site transfer due\nto the creation of a ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/replica_management",children:"replication rule"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"replica-paths-on-storage",children:"Replica paths on storage"}),"\n",(0,s.jsxs)(t.p,{children:["Rucio has two basic paradigms in deciding the path for a replica on a specific\nstorage system. ",(0,s.jsx)(t.strong,{children:"Deterministic"})," and ",(0,s.jsx)(t.strong,{children:"Non-deterministic"})," paths. If we assume\na file whose data identifier is ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"}),", thus the scope is\n",(0,s.jsx)(t.code,{children:"user.jdoe"})," and the name is ",(0,s.jsx)(t.code,{children:"test.file.1"}),". In Rucio a deterministically created\npath is a path which can be generated solely knowing the scope and name of a\ndata identifier (Ignoring the static prefix of the storage endpoint). For a\nnon-deterministic path additional information describing the file is necessary,\nsuch as meta-data, the dataset the file belongs to, etc."]}),"\n",(0,s.jsx)(t.p,{children:"Rucio supports pluggable algorithms for both deterministic and non-deterministic\nalgorithms. This section explains a few of them."}),"\n",(0,s.jsx)(t.h2,{id:"deterministic-algorithm-based-on-hashes",children:"Deterministic algorithm based on hashes"}),"\n",(0,s.jsx)(t.p,{children:"The hash deterministic algorithm is an algorithm commonly used in Rucio. The\nadvantage of this algorithm is that, due to the characteristics of cryptographic\nhash functions, the files are evenly distributed to directories. This can be an\nimportant characteristic for storage systems whose access performance degrades\nbased on the number of files in a directory."}),"\n",(0,s.jsxs)(t.p,{children:["For a data identifier, e.g. ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," a md5-hashsum is calculated\n",(0,s.jsx)(t.code,{children:"077c8119053bebb168d125034bff64ac"}),". The generated path is then based on the\nfirst four characters of the hashsum. e.g. ",(0,s.jsx)(t.code,{children:"/user/jdoe/07/7c/test.file.1"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"deterministic-algorithm-based-on-naming-convention",children:"Deterministic algorithm based on naming convention"}),"\n",(0,s.jsx)(t.p,{children:"If a specific naming convention is enforced on the filenames, a possible\ndeterministic algorithm can be based on it."}),"\n",(0,s.jsxs)(t.p,{children:["For the data identifier ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," the first part of the filename\n(",(0,s.jsx)(t.code,{children:"test"}),") is extracted and used to generate the path: ",(0,s.jsx)(t.code,{children:"/test/user.jdoe/file.1"})]}),"\n",(0,s.jsx)(t.h2,{id:"non-deterministic-algorithm-based-on-parent-dataset",children:"Non-Deterministic algorithm based on parent dataset"}),"\n",(0,s.jsxs)(t.p,{children:["If the file is part of a dataset, e.g. ",(0,s.jsx)(t.code,{children:"data:dataset1234"})," the dataset can be\nused in the path of the filename. This is useful for e.g. tape storage systems,\nto keep the files belonging to the same dataset on the same tape."]}),"\n",(0,s.jsxs)(t.p,{children:["For the data identifier ",(0,s.jsx)(t.code,{children:"user.jdoe:test.file.1"})," which is part of the dataset\n",(0,s.jsx)(t.code,{children:"data:dataset1234"})," the generated path is:\n",(0,s.jsx)(t.code,{children:"/data/dataset1234/user.jdoe/test.file.1"})]}),"\n",(0,s.jsx)(t.h2,{id:"replica-is-uploaded-with-the-command-line-client",children:"Replica is uploaded with the command line client"}),"\n",(0,s.jsx)(t.p,{children:"This is a typical workflow when a user uploads multiple files, which are part of\na dataset, via the command line client."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The dataset ",(0,s.jsx)(t.code,{children:"test.dataset"})," is being registered at the server. All files, or\ndatasets are associated to a ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/file_dataset_container",children:"scope"}),", if not\nspecifically mentioned the client will assume the default scope of the user,\nsuch as ",(0,s.jsx)(t.code,{children:"user.jdoe"}),". Thus the full data identifier for the dataset is\n",(0,s.jsx)(t.code,{children:"user.jdoe:test.dataset"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The client queries the RSE information from the server. This not only gives a\nlist of prioritized write protocols to use but also the information if the\nRSE is a deterministic or non-deterministic one."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The file replica is registered as ",(0,s.jsx)(t.code,{children:"COPYING"})," on the RSE."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Based on the identified naming algorithm of the RSE and the list of\nprioritized write protocols, the file URL is calculated. e.g. using the hash\nalgorithm from above:\n",(0,s.jsx)(t.code,{children:"https://storageserver.organization.org/VO/data/user/jdoe/07/7c/test.file.1"})]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The file upload is done with the first prioritized protocol. If the upload\nfails, step 4 is repeated with the second prioritized protocol, etc."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Once the upload is successfully finished, the replica state is changed to\n",(0,s.jsx)(t.code,{children:"AVAILABLE"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Step 3-6 are repeated (done in parallel) with all other files part of the\nuploaded dataset."}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"replica-is-created-by-a-replication-rule",children:"Replica is created by a replication rule"}),"\n",(0,s.jsx)(t.p,{children:"This is a typical workflow if a file already exists in Rucio but the user wants\nto replicate it to a different RSE."}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["The user creates a replication rule for the dataset ",(0,s.jsx)(t.code,{children:"user.jdoe:test.dataset"}),"\nat the server."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The Rucio server creates internal requests for each single file in the\ndataset and puts them in a queue to be read by the data transfer service."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The data transfer submitter picks these requests up and queries the\ndestination RSE information for each file."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Based on the identified naming algorithm of the destination RSE it creates\nthe destination URLs and creates the file replicas in ",(0,s.jsx)(t.code,{children:"COPYING"})," state."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"The transfer service then submits the transfer job to the connected transfer\ntool (e.g. FTS)"}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["Once the transfers are finished the transfer tool notifies Rucio about the\ntransfer success and the transfer services mark the replicas as ",(0,s.jsx)(t.code,{children:"AVAILABLE"}),"."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>o});var n=i(96540);const s={},a=n.createContext(s);function r(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/138181e0.93ca54a1.js b/assets/js/138181e0.93ca54a1.js deleted file mode 100644 index 43bc02a343..0000000000 --- a/assets/js/138181e0.93ca54a1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5152],{5640:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"started/concepts/notifications","title":"Notifications","description":"External applications can require synchronisation on events relative to","source":"@site/../docs/started/concepts/notifications.md","sourceDirName":"started/concepts","slug":"/started/concepts/notifications","permalink":"/documentation/started/concepts/notifications","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/notifications.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"notifications","title":"Notifications","sidebar_label":"Notifications"},"sidebar":"docs","previous":{"title":"Accounting and quota","permalink":"/documentation/started/concepts/accounting_and_quota"},"next":{"title":"Subscriptions","permalink":"/documentation/started/concepts/subscriptions"}}');var o=n(74848),s=n(28453);const a={id:"notifications",title:"Notifications",sidebar_label:"Notifications"},c=void 0,r={},d=[];function p(t){const e={a:"a",p:"p",...(0,s.R)(),...t.components};return(0,o.jsxs)(e.p,{children:["External applications can require synchronisation on events relative to\ndata availability and can subscribe to particular events, e.g., dataset\nstate changes, replication rule state changes, etc. Rucio publishes\nmessages via the ",(0,o.jsx)(e.a,{href:"https://stomp.github.io",children:"STOMP"})," protocol (to e.g.\n",(0,o.jsx)(e.a,{href:"https://activemq.apache.org",children:"ActiveMQ"}),") when these events happen."]})}function u(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,o.jsx)(e,{...t,children:(0,o.jsx)(p,{...t})}):p(t)}},28453:(t,e,n)=>{n.d(e,{R:()=>a,x:()=>c});var i=n(96540);const o={},s=i.createContext(o);function a(t){const e=i.useContext(s);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(o):t.components||o:a(t.components),i.createElement(s.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/138181e0.9ca5d018.js b/assets/js/138181e0.9ca5d018.js new file mode 100644 index 0000000000..0ccbb60d5a --- /dev/null +++ b/assets/js/138181e0.9ca5d018.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5152],{5640:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"started/concepts/notifications","title":"Notifications","description":"External applications can require synchronisation on events relative to","source":"@site/../docs/started/concepts/notifications.md","sourceDirName":"started/concepts","slug":"/started/concepts/notifications","permalink":"/documentation/started/concepts/notifications","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/notifications.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"notifications","title":"Notifications","sidebar_label":"Notifications"},"sidebar":"docs","previous":{"title":"Accounting and quota","permalink":"/documentation/started/concepts/accounting_and_quota"},"next":{"title":"Subscriptions","permalink":"/documentation/started/concepts/subscriptions"}}');var i=n(74848),s=n(28453);const a={id:"notifications",title:"Notifications",sidebar_label:"Notifications"},c=void 0,r={},d=[];function p(t){const e={a:"a",p:"p",...(0,s.R)(),...t.components};return(0,i.jsxs)(e.p,{children:["External applications can require synchronisation on events relative to\ndata availability and can subscribe to particular events, e.g., dataset\nstate changes, replication rule state changes, etc. Rucio publishes\nmessages via the ",(0,i.jsx)(e.a,{href:"https://stomp.github.io",children:"STOMP"})," protocol (to e.g.\n",(0,i.jsx)(e.a,{href:"https://activemq.apache.org",children:"ActiveMQ"}),") when these events happen."]})}function u(t={}){const{wrapper:e}={...(0,s.R)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(p,{...t})}):p(t)}},28453:(t,e,n)=>{n.d(e,{R:()=>a,x:()=>c});var o=n(96540);const i={},s=o.createContext(i);function a(t){const e=o.useContext(s);return o.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function c(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:a(t.components),o.createElement(s.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/16a6bed5.1d69329d.js b/assets/js/16a6bed5.1d69329d.js new file mode 100644 index 0000000000..1772031304 --- /dev/null +++ b/assets/js/16a6bed5.1d69329d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[7101],{31173:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>l});const o=JSON.parse('{"id":"developer/project_structure","title":"Project Structure","description":"The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication.","source":"@site/../docs/developer/project_structure.md","sourceDirName":"developer","slug":"/developer/project_structure","permalink":"/documentation/developer/project_structure","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/project_structure.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"project_structure","title":"Project Structure"},"sidebar":"docs","previous":{"title":"Dependency management","permalink":"/documentation/developer/dependency_management"},"next":{"title":"REST API Documentation","permalink":"/documentation/developer/rest_api_doc"}}');var i=n(74848),s=n(28453);const r={id:"project_structure",title:"Project Structure"},a=void 0,c={},l=[{value:"Core",id:"core",level:2},{value:"Common",id:"common",level:2},{value:"Client",id:"client",level:2},{value:"Daemons",id:"daemons",level:2},{value:"Gateway",id:"gateway",level:2},{value:"Web",id:"web",level:2},{value:"Other",id:"other",level:2},{value:"DB",id:"db",level:3},{value:"RSE",id:"rse",level:3},{value:"Tests",id:"tests",level:3},{value:"Transfertool",id:"transfertool",level:3}];function d(e){const t={code:"code",h2:"h2",h3:"h3",img:"img",p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication.\nBefore making a change, it is important to consider how your change will be used across different releases.\nThis will greatly impact the structure of your change."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"A simplified diagram of Rucio's code structure. It is broken into 3 boxes labeled "Rucio", "Rucio Web" and "Rucio Client". The "Rucio" box contains the web and client boxes.",src:n(17066).A+"",width:"2980",height:"1407"})}),"\n",(0,i.jsx)(t.h2,{id:"core",children:"Core"}),"\n",(0,i.jsx)(t.p,{children:"Core contains the main functionality of the project, it can be conceptualized as rucio's central logic.\nAny changes that need to impact all of rucio should be made in core.\nFor example: if a new feature introduces a new type of DID, the logic for this is included in the core, and then the ways for users and operators to use this logic is included in different parts of the code (namely, in client, gateway, and web)."}),"\n",(0,i.jsx)(t.h2,{id:"common",children:"Common"}),"\n",(0,i.jsx)(t.p,{children:"Common contains code used across client and server modules.\nCode in common is distributed with server and client releases, so if the functionality is required in both releases, it is included in common.\nThis includes things like configuration parsing, logging, and generalized utility/helper functions."}),"\n",(0,i.jsx)(t.h2,{id:"client",children:"Client"}),"\n",(0,i.jsx)(t.p,{children:"Client is a standalone module which sends requests to a server.\nIt can make calls to the Common module, but does not require direct knowledge of core's operation.\nIt contacts the Rest API hosted in web."}),"\n",(0,i.jsx)(t.p,{children:"bin/rucio and bin/rucio-admin utilize functionality hosted in client."}),"\n",(0,i.jsx)(t.p,{children:"If your change impacts how the user interacts with rucio, (the name of calls, arguments), this change should be made in client."}),"\n",(0,i.jsx)(t.h2,{id:"daemons",children:"Daemons"}),"\n",(0,i.jsx)(t.p,{children:"Daemons are auxiliary server side code to run asynchronous work without direct user interaction.\nThey do not need to be run, but are included with server releases.\nChanges impacting daemons are generally self-contained in the daemons."}),"\n",(0,i.jsx)(t.h2,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsx)(t.p,{children:"Gateway is a series of recipes for basic operations using core functionality.\nIt allows for functionality of the core to be used with correct database sessions, authentication parameters.\nIt is an intermediate layer between the core and the Rest API - the Rest API utilizes the gateway to make calls to core."}),"\n",(0,i.jsx)(t.p,{children:"All public core methods should have a corresponding gateway method to handle sessions and authentication."}),"\n",(0,i.jsx)(t.h2,{id:"web",children:"Web"}),"\n",(0,i.jsxs)(t.p,{children:["Web contains the flask-based Rest API for the client to contact the server.\n(Found at ",(0,i.jsx)(t.code,{children:"/lib/rucio/web/rest/flaskapi/v1"}),").\nIt also contains the routing for a Web UI front end.\nWhen adding new functionality, or modifying the arguments of an existing function, it is imperative to update the Rest API."]}),"\n",(0,i.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,i.jsx)(t.h3,{id:"db",children:"DB"}),"\n",(0,i.jsx)(t.p,{children:"As the name implies, DB contains database schema and connection utilities.\nIt is included in server releases of rucio.\nChanges in the database dramatically impact all other parts of the code, such as core's database queries.\nA migration instruction script must be included with DB changes to ensure data is not lost during upgrade or downgrades."}),"\n",(0,i.jsx)(t.h3,{id:"rse",children:"RSE"}),"\n",(0,i.jsx)(t.p,{children:"RSE provides different protocols to access RSEs (ex: ssh, srm.)\nIt is included client distributions, and all RSE protocols must be able to run without direct access to core."}),"\n",(0,i.jsx)(t.h3,{id:"tests",children:"Tests"}),"\n",(0,i.jsx)(t.p,{children:"Tests contains utilities for testing."}),"\n",(0,i.jsx)(t.h3,{id:"transfertool",children:"Transfertool"}),"\n",(0,i.jsx)(t.p,{children:"Similar to RSE, transfertool contains protocols for executing file transfers.\nIt can include calls to core, as transfer protocols sit server side."})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},17066:(e,t,n)=>{n.d(t,{A:()=>o});const o=n.p+"assets/images/code_structure-0ffa3c51952bfcec2e40267dc1343fb7.png"},28453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var o=n(96540);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/16a6bed5.2ee8c7fb.js b/assets/js/16a6bed5.2ee8c7fb.js deleted file mode 100644 index fb25d061cf..0000000000 --- a/assets/js/16a6bed5.2ee8c7fb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[7101],{31173:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"developer/project_structure","title":"Project Structure","description":"The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication.","source":"@site/../docs/developer/project_structure.md","sourceDirName":"developer","slug":"/developer/project_structure","permalink":"/documentation/developer/project_structure","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/project_structure.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"project_structure","title":"Project Structure"},"sidebar":"docs","previous":{"title":"Dependency management","permalink":"/documentation/developer/dependency_management"},"next":{"title":"REST API Documentation","permalink":"/documentation/developer/rest_api_doc"}}');var o=n(74848),s=n(28453);const r={id:"project_structure",title:"Project Structure"},a=void 0,c={},l=[{value:"Core",id:"core",level:2},{value:"Common",id:"common",level:2},{value:"Client",id:"client",level:2},{value:"Daemons",id:"daemons",level:2},{value:"Gateway",id:"gateway",level:2},{value:"Web",id:"web",level:2},{value:"Other",id:"other",level:2},{value:"DB",id:"db",level:3},{value:"RSE",id:"rse",level:3},{value:"Tests",id:"tests",level:3},{value:"Transfertool",id:"transfertool",level:3}];function d(e){const t={code:"code",h2:"h2",h3:"h3",img:"img",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication.\nBefore making a change, it is important to consider how your change will be used across different releases.\nThis will greatly impact the structure of your change."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"A simplified diagram of Rucio's code structure. It is broken into 3 boxes labeled "Rucio", "Rucio Web" and "Rucio Client". The "Rucio" box contains the web and client boxes.",src:n(17066).A+"",width:"2980",height:"1407"})}),"\n",(0,o.jsx)(t.h2,{id:"core",children:"Core"}),"\n",(0,o.jsx)(t.p,{children:"Core contains the main functionality of the project, it can be conceptualized as rucio's central logic.\nAny changes that need to impact all of rucio should be made in core.\nFor example: if a new feature introduces a new type of DID, the logic for this is included in the core, and then the ways for users and operators to use this logic is included in different parts of the code (namely, in client, gateway, and web)."}),"\n",(0,o.jsx)(t.h2,{id:"common",children:"Common"}),"\n",(0,o.jsx)(t.p,{children:"Common contains code used across client and server modules.\nCode in common is distributed with server and client releases, so if the functionality is required in both releases, it is included in common.\nThis includes things like configuration parsing, logging, and generalized utility/helper functions."}),"\n",(0,o.jsx)(t.h2,{id:"client",children:"Client"}),"\n",(0,o.jsx)(t.p,{children:"Client is a standalone module which sends requests to a server.\nIt can make calls to the Common module, but does not require direct knowledge of core's operation.\nIt contacts the Rest API hosted in web."}),"\n",(0,o.jsx)(t.p,{children:"bin/rucio and bin/rucio-admin utilize functionality hosted in client."}),"\n",(0,o.jsx)(t.p,{children:"If your change impacts how the user interacts with rucio, (the name of calls, arguments), this change should be made in client."}),"\n",(0,o.jsx)(t.h2,{id:"daemons",children:"Daemons"}),"\n",(0,o.jsx)(t.p,{children:"Daemons are auxiliary server side code to run asynchronous work without direct user interaction.\nThey do not need to be run, but are included with server releases.\nChanges impacting daemons are generally self-contained in the daemons."}),"\n",(0,o.jsx)(t.h2,{id:"gateway",children:"Gateway"}),"\n",(0,o.jsx)(t.p,{children:"Gateway is a series of recipes for basic operations using core functionality.\nIt allows for functionality of the core to be used with correct database sessions, authentication parameters.\nIt is an intermediate layer between the core and the Rest API - the Rest API utilizes the gateway to make calls to core."}),"\n",(0,o.jsx)(t.p,{children:"All public core methods should have a corresponding gateway method to handle sessions and authentication."}),"\n",(0,o.jsx)(t.h2,{id:"web",children:"Web"}),"\n",(0,o.jsxs)(t.p,{children:["Web contains the flask-based Rest API for the client to contact the server.\n(Found at ",(0,o.jsx)(t.code,{children:"/lib/rucio/web/rest/flaskapi/v1"}),").\nIt also contains the routing for a Web UI front end.\nWhen adding new functionality, or modifying the arguments of an existing function, it is imperative to update the Rest API."]}),"\n",(0,o.jsx)(t.h2,{id:"other",children:"Other"}),"\n",(0,o.jsx)(t.h3,{id:"db",children:"DB"}),"\n",(0,o.jsx)(t.p,{children:"As the name implies, DB contains database schema and connection utilities.\nIt is included in server releases of rucio.\nChanges in the database dramatically impact all other parts of the code, such as core's database queries.\nA migration instruction script must be included with DB changes to ensure data is not lost during upgrade or downgrades."}),"\n",(0,o.jsx)(t.h3,{id:"rse",children:"RSE"}),"\n",(0,o.jsx)(t.p,{children:"RSE provides different protocols to access RSEs (ex: ssh, srm.)\nIt is included client distributions, and all RSE protocols must be able to run without direct access to core."}),"\n",(0,o.jsx)(t.h3,{id:"tests",children:"Tests"}),"\n",(0,o.jsx)(t.p,{children:"Tests contains utilities for testing."}),"\n",(0,o.jsx)(t.h3,{id:"transfertool",children:"Transfertool"}),"\n",(0,o.jsx)(t.p,{children:"Similar to RSE, transfertool contains protocols for executing file transfers.\nIt can include calls to core, as transfer protocols sit server side."})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},17066:(e,t,n)=>{n.d(t,{A:()=>i});const i=n.p+"assets/images/code_structure-0ffa3c51952bfcec2e40267dc1343fb7.png"},28453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>a});var i=n(96540);const o={},s=i.createContext(o);function r(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1705cd3e.3680001c.js b/assets/js/1705cd3e.3680001c.js deleted file mode 100644 index 652396aead..0000000000 --- a/assets/js/1705cd3e.3680001c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8015],{71673:(i,e,n)=>{n.r(e),n.d(e,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>r,toc:()=>t});const r=JSON.parse('{"id":"about_our_contributors","title":"About Our Contributors","description":"Below is a list of contibutors who have contributed to the","source":"@site/../docs/about_our_contributors.md","sourceDirName":".","slug":"/about_our_contributors","permalink":"/documentation/about_our_contributors","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/about_our_contributors.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"about_our_contributors","title":"About Our Contributors"},"sidebar":"docs","previous":{"title":"Special Interest Groups","permalink":"/documentation/special_interest_groups"},"next":{"title":"Contact us","permalink":"/documentation/contact_us"}}');var a=n(74848),l=n(28453);const s={id:"about_our_contributors",title:"About Our Contributors"},c="Individual contributors to the source code",o={},t=[];function h(i){const e={a:"a",h1:"h1",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,l.R)(),...i.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.p,{children:"Below is a list of contibutors who have contributed to the\nsource code & their employers."}),"\n",(0,a.jsxs)(e.p,{children:["Should you wish to contribute to the Rucio source code or the documentation,\nplease ensure you go through the guidelines listed in the ",(0,a.jsx)(e.a,{href:"contributing",children:(0,a.jsx)(e.strong,{children:"contribution guide\nfor developers"})})," and look into the ",(0,a.jsx)(e.a,{href:"https://github.com/rucio/documentation",children:"documentation GitHub\nrepository"})," before making a submission."]}),"\n",(0,a.jsx)(e.header,{children:(0,a.jsx)(e.h1,{id:"individual-contributors-to-the-source-code",children:"Individual contributors to the source code"})}),"\n",(0,a.jsx)(e.hr,{}),"\n",(0,a.jsxs)(e.ul,{children:["\n",(0,a.jsxs)(e.li,{children:["Mario Lassnig ",(0,a.jsx)(e.a,{href:"mailto:mario.lassnig@cern.ch",children:"mario.lassnig@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Vincent Garonne ",(0,a.jsx)(e.a,{href:"mailto:vgaronne@gmail.com",children:"vgaronne@gmail.com"}),", 2012-2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Angelos Molfetas ",(0,a.jsx)(e.a,{href:"mailto:Angelos.Molfetas@cern.ch",children:"Angelos.Molfetas@cern.c"}),", 2012"]}),"\n",(0,a.jsxs)(e.li,{children:["Martin Barisits ",(0,a.jsx)(e.a,{href:"mailto:martin.barisits@cern.ch",children:"martin.barisits@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Thomas Beermann ",(0,a.jsx)(e.a,{href:"mailto:thomas.beermann@cern.ch",children:"thomas.beermann@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Ralph Vigne ",(0,a.jsx)(e.a,{href:"mailto:ralph.vigne@cern.ch",children:"ralph.vigne@cern.ch"}),", 2012-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Graeme Stewart ",(0,a.jsx)(e.a,{href:"mailto:graeme.andrew.stewart@cern.ch",children:"graeme.andrew.stewart@cern.ch"}),", 2012"]}),"\n",(0,a.jsxs)(e.li,{children:["Yun-Pin Sun ",(0,a.jsx)(e.a,{href:"mailto:winter0128@gmail.com",children:"winter0128@gmail.com"}),", 2012-2013"]}),"\n",(0,a.jsxs)(e.li,{children:["Cedric Serfon ",(0,a.jsx)(e.a,{href:"mailto:cedric.serfon@cern.ch",children:"cedric.serfon@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Luis Rodrigues ",(0,a.jsx)(e.a,{href:"mailto:lfrodrigues@gmail.com",children:"lfrodrigues@gmail.com"}),", 2013"]}),"\n",(0,a.jsxs)(e.li,{children:["WeiJen Chang ",(0,a.jsx)(e.a,{href:"mailto:e4523744@gmail.com",children:"e4523744@gmail.com"}),", 2013-2014"]}),"\n",(0,a.jsxs)(e.li,{children:["Gancho Dimitrov ",(0,a.jsx)(e.a,{href:"mailto:gancho.dimitrov@cern.ch",children:"gancho.dimitrov@cern.ch"}),", 2013"]}),"\n",(0,a.jsxs)(e.li,{children:["Wen Guan ",(0,a.jsx)(e.a,{href:"mailto:wguan.icedew@gmail.com",children:"wguan.icedew@gmail.co"}),", 2014-2017"]}),"\n",(0,a.jsxs)(e.li,{children:["David Cameron ",(0,a.jsx)(e.a,{href:"mailto:d.g.cameron@gmail.com",children:"d.g.cameron@gmail.com"}),", 2014-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Tom\xe1\u0161 Kouba ",(0,a.jsx)(e.a,{href:"mailto:tomas.kouba@cern.ch",children:"tomas.kouba@cern.ch"}),", 2014-2015"]}),"\n",(0,a.jsxs)(e.li,{children:["Cheng-Hsi Chao ",(0,a.jsx)(e.a,{href:"mailto:cheng-hsi.chao@cern.ch",children:"cheng-hsi.chao@cern.ch"}),", 2014"]}),"\n",(0,a.jsxs)(e.li,{children:["Evangelia Liotiri ",(0,a.jsx)(e.a,{href:"mailto:evangelia.liotiri@cern.ch",children:"evangelia.liotiri@cern.ch"}),", 2014-2015"]}),"\n",(0,a.jsxs)(e.li,{children:["Joaqu\xedn Bogado ",(0,a.jsx)(e.a,{href:"mailto:jbogado@linti.unlp.edu.ar",children:"jbogado@linti.unlp.edu.ar"}),", 2014-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Fernando L\xf3pez ",(0,a.jsx)(e.a,{href:"mailto:fernando.e.lopez@gmail.com",children:"fernando.e.lopez@gmail.com"}),", 2015-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Sylvain Blunier ",(0,a.jsx)(e.a,{href:"mailto:sylvain.blunier@cern.ch",children:"sylvain.blunier@cern.ch"}),", 2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Tomas Javurek ",(0,a.jsx)(e.a,{href:"mailto:tomas.javurek@cern.ch",children:"tomas.javurek@cern.ch"}),", 2016-2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Brian Bockelman ",(0,a.jsx)(e.a,{href:"mailto:bbockelm@cse.unl.edu",children:"bbockelm@cse.unl.edu"}),", 2016-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Tobias Wegner ",(0,a.jsx)(e.a,{href:"mailto:twegner@cern.ch",children:"twegner@cern.ch"}),", 2017-2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Frank Berghaus ",(0,a.jsx)(e.a,{href:"mailto:frank.berghaus@cern.ch",children:"frank.berghaus@cern.ch)"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Vitjan Zavrtanik ",(0,a.jsx)(e.a,{href:"mailto:vitjan.zavrtanik@cern.ch",children:"vitjan.zavrtanik@cern.ch"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Stefan Prenner ",(0,a.jsx)(e.a,{href:"mailto:stefan.prenner@cern.ch",children:"stefan.prenner@cern.ch"}),", 2017-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Nicolo Magini ",(0,a.jsx)(e.a,{href:"mailto:Nicolo.Magini@cern.ch",children:"Nicolo.Magini@cern.ch"}),", 2017-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Oliver Freyermuth ",(0,a.jsx)(e.a,{href:"mailto:o.freyermuth@googlemail.com",children:"o.freyermuth@googlemail.co"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Eric Vaandering ",(0,a.jsx)(e.a,{href:"mailto:ericvaandering@gmail.com",children:"ericvaandering@gmail.co"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Dimitrios Christidis ",(0,a.jsx)(e.a,{href:"mailto:dimitrios.christidis@cern.ch",children:"dimitrios.christidis@cern.ch"}),", 2018-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Igor Mandrichenko ",(0,a.jsx)(e.a,{href:"mailto:ivm@fnal.gov",children:"ivm@fnal.gov"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Shreyansh Khajanchi ",(0,a.jsx)(e.a,{href:"mailto:shreyansh_k@live.com",children:"shreyansh_k@live.com"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Robert Illingworth ",(0,a.jsx)(e.a,{href:"mailto:illingwo@fnal.gov",children:"illingwo@fnal.gov"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Hannes Hansen ",(0,a.jsx)(e.a,{href:"mailto:hannes.jakob.hansen@cern.ch",children:"hannes.jakob.hansen@cern.c"}),", 2018-2019"]}),"\n",(0,a.jsxs)(e.li,{children:["James Perry ",(0,a.jsx)(e.a,{href:"mailto:j.perry@epcc.ed.ac.uk",children:"j.perry@epcc.ed.ac.uk"}),", 2019-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Vivek Nigam ",(0,a.jsx)(e.a,{href:"mailto:viveknigam.nigam3@gmail.com",children:"viveknigam.nigam3@gmail.com"}),", 2019 - 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Kaustubh Hiware ",(0,a.jsx)(e.a,{href:"mailto:hiwarekaustubh@gmail.com",children:"hiwarekaustubh@gmail.co"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Florido Paganelli ",(0,a.jsx)(e.a,{href:"mailto:florido.paganelli@hep.lu.se",children:"florido.paganelli@hep.lu.se"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Boris Bauermeister ",(0,a.jsx)(e.a,{href:"mailto:Boris.Bauermeister@gmail.com",children:"Boris.Bauermeister@gmail.com"})," 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Ruturaj Gujar ",(0,a.jsx)(e.a,{href:"mailto:ruturaj.gujar23@gmail.com",children:"ruturaj.gujar23@gmail.com"})," 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Andrew Lister ",(0,a.jsx)(e.a,{href:"mailto:andrew.lister@stfc.ac.uk",children:"andrew.lister@stfc.ac.uk"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Aristeidis Fkiaras ",(0,a.jsx)(e.a,{href:"mailto:aristeidis.fkiaras@cern.ch",children:"aristeidis.fkiaras@cern.ch"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Benedikt Ziemons ",(0,a.jsx)(e.a,{href:"mailto:benedikt.ziemons@cern.ch",children:"benedikt.ziemons@cern.ch"}),", 2020-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Muhammad Aditya Hilmy ",(0,a.jsx)(e.a,{href:"mailto:mhilmy@hey.com",children:"mhilmy@hey.com"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Eli Chadwick ",(0,a.jsx)(e.a,{href:"mailto:eli.chadwick@stfc.ac.uk",children:"eli.chadwick@stfc.ac.uk"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Patrick Austin ",(0,a.jsxs)(e.a,{href:"mailto:patrick.austin@stfc.ac.uk",children:[":patrick",".austin@stfc.ac.uk"]}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Rob Barnsley ",(0,a.jsx)(e.a,{href:"mailto:R.Barnsley@skatelescope.org",children:"R.Barnsley@skatelescope.org"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Alan Malta Rodrigues ",(0,a.jsx)(e.a,{href:"mailto:alan.malta@cern.ch",children:"alan.malta@cern.ch"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Rizart Dona ",(0,a.jsx)(e.a,{href:"mailto:rizart.dona@gmail.com",children:"rizart.dona@gmail.com"}),", 2021-2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Aksel Lunde Aase ",(0,a.jsx)(e.a,{href:"mailto:aksel.lunde.aase@gmail.com",children:"aksel.lunde.aase@gmail.co"}),", 2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Anton Schwarz ",(0,a.jsx)(e.a,{href:"mailto:anton.schwarz@cern.ch",children:"anton.schwarz@cern.ch"}),", 2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Johannes Lange ",(0,a.jsx)(e.a,{href:"mailto:johannes.lange@uni-hamburg.de",children:"johannes.lange@uni-hamburg.de"}),", 2022-2023"]}),"\n",(0,a.jsxs)(e.li,{children:["Domenic Gosein ",(0,a.jsx)(e.a,{href:"mailto:domenic.gosein@cern.ch",children:"domenic.gosein@cern.ch"}),", 2023"]}),"\n",(0,a.jsxs)(e.li,{children:["Eraldo Junior ",(0,a.jsx)(e.a,{href:"mailto:esilvaju@cern.ch",children:"esilvaju@cern.ch"}),", 2021-2024"]}),"\n",(0,a.jsxs)(e.li,{children:["Dimitris Xenakis ",(0,a.jsx)(e.a,{href:"mailto:d.xenakis@ieee.org",children:"d.xenakis@ieee.org"}),", 2024"]}),"\n",(0,a.jsxs)(e.li,{children:["Fabio Luchetti ",(0,a.jsx)(e.a,{href:"mailto:fabio.luchetti@cern.ch",children:"fabio.luchetti@cern.ch"}),", 2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Giovanni Guerrieri ",(0,a.jsx)(e.a,{href:"mailto:giovanni.guerrieri@cern.ch",children:"giovanni.guerrieri@cern.ch"}),", 2024"]}),"\n"]}),"\n",(0,a.jsx)(e.h1,{id:"organisations-employing-contributors",children:"Organisations employing contributors"}),"\n",(0,a.jsx)(e.hr,{}),"\n",(0,a.jsxs)(e.ul,{children:["\n",(0,a.jsx)(e.li,{children:"European Organisation for Nuclear Research (Switzerland)"}),"\n",(0,a.jsx)(e.li,{children:"University of Oslo (Norway)"}),"\n",(0,a.jsx)(e.li,{children:"University of Wisconsin Madison (USA)"}),"\n",(0,a.jsx)(e.li,{children:"National University of La Plata (Argentina)"}),"\n",(0,a.jsx)(e.li,{children:"Albert Ludwigs Universit\xe4t Freiburg (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"University of Nebraska Lincoln (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Bergische Universit\xe4t Wuppertal (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"University of Victoria (Canada)"}),"\n",(0,a.jsx)(e.li,{children:"INFN e Universita Genova (Italy)"}),"\n",(0,a.jsx)(e.li,{children:"University of Bonn (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"Fermi National Accelerator Laboratory (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Leopold-Franzens Universit\xe4t Innsbruck (Austria)"}),"\n",(0,a.jsx)(e.li,{children:"Academia Sinica (Taiwan)"}),"\n",(0,a.jsx)(e.li,{children:"University of Edinburgh (UK)"}),"\n",(0,a.jsx)(e.li,{children:"Birla Institute of Technology, Mesra (India)"}),"\n",(0,a.jsx)(e.li,{children:"Indian Institute of Technology, Kharagpur (India)"}),"\n",(0,a.jsx)(e.li,{children:"Stockholm University, Stockholm (Sweden)"}),"\n",(0,a.jsx)(e.li,{children:"Dwarkadas J. Sanghvi College of Engineering (India)"}),"\n",(0,a.jsx)(e.li,{children:"Science and Technology Facilities Council (UK)"}),"\n",(0,a.jsx)(e.li,{children:"Brookhaven National Laboratory (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Institut Teknologi Bandung (Indonesia)"}),"\n",(0,a.jsx)(e.li,{children:"Universit\xe4t Hamburg (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"Brazilian Center for Research in Physics (Brazil)"}),"\n"]})]})}function d(i={}){const{wrapper:e}={...(0,l.R)(),...i.components};return e?(0,a.jsx)(e,{...i,children:(0,a.jsx)(h,{...i})}):h(i)}},28453:(i,e,n)=>{n.d(e,{R:()=>s,x:()=>c});var r=n(96540);const a={},l=r.createContext(a);function s(i){const e=r.useContext(l);return r.useMemo((function(){return"function"==typeof i?i(e):{...e,...i}}),[e,i])}function c(i){let e;return e=i.disableParentContext?"function"==typeof i.components?i.components(a):i.components||a:s(i.components),r.createElement(l.Provider,{value:e},i.children)}}}]); \ No newline at end of file diff --git a/assets/js/1705cd3e.c4663c9f.js b/assets/js/1705cd3e.c4663c9f.js new file mode 100644 index 0000000000..45be72270e --- /dev/null +++ b/assets/js/1705cd3e.c4663c9f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8015],{71673:(i,e,n)=>{n.r(e),n.d(e,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>r,toc:()=>t});const r=JSON.parse('{"id":"about_our_contributors","title":"About Our Contributors","description":"Below is a list of contibutors who have contributed to the","source":"@site/../docs/about_our_contributors.md","sourceDirName":".","slug":"/about_our_contributors","permalink":"/documentation/about_our_contributors","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/about_our_contributors.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"about_our_contributors","title":"About Our Contributors"},"sidebar":"docs","previous":{"title":"Special Interest Groups","permalink":"/documentation/special_interest_groups"},"next":{"title":"Contact us","permalink":"/documentation/contact_us"}}');var a=n(74848),l=n(28453);const s={id:"about_our_contributors",title:"About Our Contributors"},c="Individual contributors to the source code",o={},t=[];function h(i){const e={a:"a",h1:"h1",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,l.R)(),...i.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.p,{children:"Below is a list of contibutors who have contributed to the\nsource code & their employers."}),"\n",(0,a.jsxs)(e.p,{children:["Should you wish to contribute to the Rucio source code or the documentation,\nplease ensure you go through the guidelines listed in the ",(0,a.jsx)(e.a,{href:"contributing",children:(0,a.jsx)(e.strong,{children:"contribution guide\nfor developers"})})," and look into the ",(0,a.jsx)(e.a,{href:"https://github.com/rucio/documentation",children:"documentation GitHub\nrepository"})," before making a submission."]}),"\n",(0,a.jsx)(e.header,{children:(0,a.jsx)(e.h1,{id:"individual-contributors-to-the-source-code",children:"Individual contributors to the source code"})}),"\n",(0,a.jsx)(e.hr,{}),"\n",(0,a.jsxs)(e.ul,{children:["\n",(0,a.jsxs)(e.li,{children:["Mario Lassnig ",(0,a.jsx)(e.a,{href:"mailto:mario.lassnig@cern.ch",children:"mario.lassnig@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Vincent Garonne ",(0,a.jsx)(e.a,{href:"mailto:vgaronne@gmail.com",children:"vgaronne@gmail.com"}),", 2012-2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Angelos Molfetas ",(0,a.jsx)(e.a,{href:"mailto:Angelos.Molfetas@cern.ch",children:"Angelos.Molfetas@cern.c"}),", 2012"]}),"\n",(0,a.jsxs)(e.li,{children:["Martin Barisits ",(0,a.jsx)(e.a,{href:"mailto:martin.barisits@cern.ch",children:"martin.barisits@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Thomas Beermann ",(0,a.jsx)(e.a,{href:"mailto:thomas.beermann@cern.ch",children:"thomas.beermann@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Ralph Vigne ",(0,a.jsx)(e.a,{href:"mailto:ralph.vigne@cern.ch",children:"ralph.vigne@cern.ch"}),", 2012-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Graeme Stewart ",(0,a.jsx)(e.a,{href:"mailto:graeme.andrew.stewart@cern.ch",children:"graeme.andrew.stewart@cern.ch"}),", 2012"]}),"\n",(0,a.jsxs)(e.li,{children:["Yun-Pin Sun ",(0,a.jsx)(e.a,{href:"mailto:winter0128@gmail.com",children:"winter0128@gmail.com"}),", 2012-2013"]}),"\n",(0,a.jsxs)(e.li,{children:["Cedric Serfon ",(0,a.jsx)(e.a,{href:"mailto:cedric.serfon@cern.ch",children:"cedric.serfon@cern.ch"}),", 2012-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Luis Rodrigues ",(0,a.jsx)(e.a,{href:"mailto:lfrodrigues@gmail.com",children:"lfrodrigues@gmail.com"}),", 2013"]}),"\n",(0,a.jsxs)(e.li,{children:["WeiJen Chang ",(0,a.jsx)(e.a,{href:"mailto:e4523744@gmail.com",children:"e4523744@gmail.com"}),", 2013-2014"]}),"\n",(0,a.jsxs)(e.li,{children:["Gancho Dimitrov ",(0,a.jsx)(e.a,{href:"mailto:gancho.dimitrov@cern.ch",children:"gancho.dimitrov@cern.ch"}),", 2013"]}),"\n",(0,a.jsxs)(e.li,{children:["Wen Guan ",(0,a.jsx)(e.a,{href:"mailto:wguan.icedew@gmail.com",children:"wguan.icedew@gmail.co"}),", 2014-2017"]}),"\n",(0,a.jsxs)(e.li,{children:["David Cameron ",(0,a.jsx)(e.a,{href:"mailto:d.g.cameron@gmail.com",children:"d.g.cameron@gmail.com"}),", 2014-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Tom\xe1\u0161 Kouba ",(0,a.jsx)(e.a,{href:"mailto:tomas.kouba@cern.ch",children:"tomas.kouba@cern.ch"}),", 2014-2015"]}),"\n",(0,a.jsxs)(e.li,{children:["Cheng-Hsi Chao ",(0,a.jsx)(e.a,{href:"mailto:cheng-hsi.chao@cern.ch",children:"cheng-hsi.chao@cern.ch"}),", 2014"]}),"\n",(0,a.jsxs)(e.li,{children:["Evangelia Liotiri ",(0,a.jsx)(e.a,{href:"mailto:evangelia.liotiri@cern.ch",children:"evangelia.liotiri@cern.ch"}),", 2014-2015"]}),"\n",(0,a.jsxs)(e.li,{children:["Joaqu\xedn Bogado ",(0,a.jsx)(e.a,{href:"mailto:jbogado@linti.unlp.edu.ar",children:"jbogado@linti.unlp.edu.ar"}),", 2014-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Fernando L\xf3pez ",(0,a.jsx)(e.a,{href:"mailto:fernando.e.lopez@gmail.com",children:"fernando.e.lopez@gmail.com"}),", 2015-2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Sylvain Blunier ",(0,a.jsx)(e.a,{href:"mailto:sylvain.blunier@cern.ch",children:"sylvain.blunier@cern.ch"}),", 2016"]}),"\n",(0,a.jsxs)(e.li,{children:["Tomas Javurek ",(0,a.jsx)(e.a,{href:"mailto:tomas.javurek@cern.ch",children:"tomas.javurek@cern.ch"}),", 2016-2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Brian Bockelman ",(0,a.jsx)(e.a,{href:"mailto:bbockelm@cse.unl.edu",children:"bbockelm@cse.unl.edu"}),", 2016-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Tobias Wegner ",(0,a.jsx)(e.a,{href:"mailto:twegner@cern.ch",children:"twegner@cern.ch"}),", 2017-2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Frank Berghaus ",(0,a.jsx)(e.a,{href:"mailto:frank.berghaus@cern.ch",children:"frank.berghaus@cern.ch)"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Vitjan Zavrtanik ",(0,a.jsx)(e.a,{href:"mailto:vitjan.zavrtanik@cern.ch",children:"vitjan.zavrtanik@cern.ch"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Stefan Prenner ",(0,a.jsx)(e.a,{href:"mailto:stefan.prenner@cern.ch",children:"stefan.prenner@cern.ch"}),", 2017-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Nicolo Magini ",(0,a.jsx)(e.a,{href:"mailto:Nicolo.Magini@cern.ch",children:"Nicolo.Magini@cern.ch"}),", 2017-2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Oliver Freyermuth ",(0,a.jsx)(e.a,{href:"mailto:o.freyermuth@googlemail.com",children:"o.freyermuth@googlemail.co"}),", 2017"]}),"\n",(0,a.jsxs)(e.li,{children:["Eric Vaandering ",(0,a.jsx)(e.a,{href:"mailto:ericvaandering@gmail.com",children:"ericvaandering@gmail.co"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Dimitrios Christidis ",(0,a.jsx)(e.a,{href:"mailto:dimitrios.christidis@cern.ch",children:"dimitrios.christidis@cern.ch"}),", 2018-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Igor Mandrichenko ",(0,a.jsx)(e.a,{href:"mailto:ivm@fnal.gov",children:"ivm@fnal.gov"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Shreyansh Khajanchi ",(0,a.jsx)(e.a,{href:"mailto:shreyansh_k@live.com",children:"shreyansh_k@live.com"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Robert Illingworth ",(0,a.jsx)(e.a,{href:"mailto:illingwo@fnal.gov",children:"illingwo@fnal.gov"}),", 2018"]}),"\n",(0,a.jsxs)(e.li,{children:["Hannes Hansen ",(0,a.jsx)(e.a,{href:"mailto:hannes.jakob.hansen@cern.ch",children:"hannes.jakob.hansen@cern.c"}),", 2018-2019"]}),"\n",(0,a.jsxs)(e.li,{children:["James Perry ",(0,a.jsx)(e.a,{href:"mailto:j.perry@epcc.ed.ac.uk",children:"j.perry@epcc.ed.ac.uk"}),", 2019-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Vivek Nigam ",(0,a.jsx)(e.a,{href:"mailto:viveknigam.nigam3@gmail.com",children:"viveknigam.nigam3@gmail.com"}),", 2019 - 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Kaustubh Hiware ",(0,a.jsx)(e.a,{href:"mailto:hiwarekaustubh@gmail.com",children:"hiwarekaustubh@gmail.co"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Florido Paganelli ",(0,a.jsx)(e.a,{href:"mailto:florido.paganelli@hep.lu.se",children:"florido.paganelli@hep.lu.se"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Boris Bauermeister ",(0,a.jsx)(e.a,{href:"mailto:Boris.Bauermeister@gmail.com",children:"Boris.Bauermeister@gmail.com"})," 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Ruturaj Gujar ",(0,a.jsx)(e.a,{href:"mailto:ruturaj.gujar23@gmail.com",children:"ruturaj.gujar23@gmail.com"})," 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Andrew Lister ",(0,a.jsx)(e.a,{href:"mailto:andrew.lister@stfc.ac.uk",children:"andrew.lister@stfc.ac.uk"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Aristeidis Fkiaras ",(0,a.jsx)(e.a,{href:"mailto:aristeidis.fkiaras@cern.ch",children:"aristeidis.fkiaras@cern.ch"}),", 2019"]}),"\n",(0,a.jsxs)(e.li,{children:["Benedikt Ziemons ",(0,a.jsx)(e.a,{href:"mailto:benedikt.ziemons@cern.ch",children:"benedikt.ziemons@cern.ch"}),", 2020-2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Muhammad Aditya Hilmy ",(0,a.jsx)(e.a,{href:"mailto:mhilmy@hey.com",children:"mhilmy@hey.com"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Eli Chadwick ",(0,a.jsx)(e.a,{href:"mailto:eli.chadwick@stfc.ac.uk",children:"eli.chadwick@stfc.ac.uk"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Patrick Austin ",(0,a.jsxs)(e.a,{href:"mailto:patrick.austin@stfc.ac.uk",children:[":patrick",".austin@stfc.ac.uk"]}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Rob Barnsley ",(0,a.jsx)(e.a,{href:"mailto:R.Barnsley@skatelescope.org",children:"R.Barnsley@skatelescope.org"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Alan Malta Rodrigues ",(0,a.jsx)(e.a,{href:"mailto:alan.malta@cern.ch",children:"alan.malta@cern.ch"}),", 2020"]}),"\n",(0,a.jsxs)(e.li,{children:["Rizart Dona ",(0,a.jsx)(e.a,{href:"mailto:rizart.dona@gmail.com",children:"rizart.dona@gmail.com"}),", 2021-2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Aksel Lunde Aase ",(0,a.jsx)(e.a,{href:"mailto:aksel.lunde.aase@gmail.com",children:"aksel.lunde.aase@gmail.co"}),", 2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Anton Schwarz ",(0,a.jsx)(e.a,{href:"mailto:anton.schwarz@cern.ch",children:"anton.schwarz@cern.ch"}),", 2022"]}),"\n",(0,a.jsxs)(e.li,{children:["Johannes Lange ",(0,a.jsx)(e.a,{href:"mailto:johannes.lange@uni-hamburg.de",children:"johannes.lange@uni-hamburg.de"}),", 2022-2023"]}),"\n",(0,a.jsxs)(e.li,{children:["Domenic Gosein ",(0,a.jsx)(e.a,{href:"mailto:domenic.gosein@cern.ch",children:"domenic.gosein@cern.ch"}),", 2023"]}),"\n",(0,a.jsxs)(e.li,{children:["Eraldo Junior ",(0,a.jsx)(e.a,{href:"mailto:esilvaju@cern.ch",children:"esilvaju@cern.ch"}),", 2021-2024"]}),"\n",(0,a.jsxs)(e.li,{children:["Dimitris Xenakis ",(0,a.jsx)(e.a,{href:"mailto:d.xenakis@ieee.org",children:"d.xenakis@ieee.org"}),", 2024"]}),"\n",(0,a.jsxs)(e.li,{children:["Fabio Luchetti ",(0,a.jsx)(e.a,{href:"mailto:fabio.luchetti@cern.ch",children:"fabio.luchetti@cern.ch"}),", 2021"]}),"\n",(0,a.jsxs)(e.li,{children:["Giovanni Guerrieri ",(0,a.jsx)(e.a,{href:"mailto:giovanni.guerrieri@cern.ch",children:"giovanni.guerrieri@cern.ch"}),", 2024"]}),"\n"]}),"\n",(0,a.jsx)(e.h1,{id:"organisations-employing-contributors",children:"Organisations employing contributors"}),"\n",(0,a.jsx)(e.hr,{}),"\n",(0,a.jsxs)(e.ul,{children:["\n",(0,a.jsx)(e.li,{children:"European Organisation for Nuclear Research (Switzerland)"}),"\n",(0,a.jsx)(e.li,{children:"University of Oslo (Norway)"}),"\n",(0,a.jsx)(e.li,{children:"University of Wisconsin Madison (USA)"}),"\n",(0,a.jsx)(e.li,{children:"National University of La Plata (Argentina)"}),"\n",(0,a.jsx)(e.li,{children:"Albert Ludwigs Universit\xe4t Freiburg (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"University of Nebraska Lincoln (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Bergische Universit\xe4t Wuppertal (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"University of Victoria (Canada)"}),"\n",(0,a.jsx)(e.li,{children:"INFN e Universita Genova (Italy)"}),"\n",(0,a.jsx)(e.li,{children:"University of Bonn (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"Fermi National Accelerator Laboratory (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Leopold-Franzens Universit\xe4t Innsbruck (Austria)"}),"\n",(0,a.jsx)(e.li,{children:"Academia Sinica (Taiwan)"}),"\n",(0,a.jsx)(e.li,{children:"University of Edinburgh (UK)"}),"\n",(0,a.jsx)(e.li,{children:"Birla Institute of Technology, Mesra (India)"}),"\n",(0,a.jsx)(e.li,{children:"Indian Institute of Technology, Kharagpur (India)"}),"\n",(0,a.jsx)(e.li,{children:"Stockholm University, Stockholm (Sweden)"}),"\n",(0,a.jsx)(e.li,{children:"Dwarkadas J. Sanghvi College of Engineering (India)"}),"\n",(0,a.jsx)(e.li,{children:"Science and Technology Facilities Council (UK)"}),"\n",(0,a.jsx)(e.li,{children:"Brookhaven National Laboratory (USA)"}),"\n",(0,a.jsx)(e.li,{children:"Institut Teknologi Bandung (Indonesia)"}),"\n",(0,a.jsx)(e.li,{children:"Universit\xe4t Hamburg (Germany)"}),"\n",(0,a.jsx)(e.li,{children:"Brazilian Center for Research in Physics (Brazil)"}),"\n"]})]})}function d(i={}){const{wrapper:e}={...(0,l.R)(),...i.components};return e?(0,a.jsx)(e,{...i,children:(0,a.jsx)(h,{...i})}):h(i)}},28453:(i,e,n)=>{n.d(e,{R:()=>s,x:()=>c});var r=n(96540);const a={},l=r.createContext(a);function s(i){const e=r.useContext(l);return r.useMemo((function(){return"function"==typeof i?i(e):{...e,...i}}),[e,i])}function c(i){let e;return e=i.disableParentContext?"function"==typeof i.components?i.components(a):i.components||a:s(i.components),r.createElement(l.Provider,{value:e},i.children)}}}]); \ No newline at end of file diff --git a/assets/js/171dad78.40dceea7.js b/assets/js/171dad78.40dceea7.js deleted file mode 100644 index eecce23c22..0000000000 --- a/assets/js/171dad78.40dceea7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5874],{95148:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"started/before_you_get_started","title":"Before you get started","description":"A great starting point for those absolutely new to Rucio, this section aims to","source":"@site/../docs/started/before_you_get_started.md","sourceDirName":"started","slug":"/started/before_you_get_started","permalink":"/documentation/started/before_you_get_started","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/before_you_get_started.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"before_you_get_started","title":"Before you get started"},"sidebar":"docs","previous":{"title":"Welcome","permalink":"/documentation/"},"next":{"title":"What is Rucio?","permalink":"/documentation/started/what_is_rucio"}}');var s=o(74848),r=o(28453);const a={id:"before_you_get_started",title:"Before you get started"},i=void 0,d={},c=[];function u(t){const e={a:"a",li:"li",p:"p",ul:"ul",...(0,r.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.p,{children:"A great starting point for those absolutely new to Rucio, this section aims to\nhelps you understand the basics of our Data Management system. The motivations\nbehind this project, what we are looking to achieve, & what we have done so far\nare some of the points covered in this section."}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/what_is_rucio",children:"What is Rucio?"})}),"\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/main_components",children:"Main Components"})}),"\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/additional_layers_and_resources",children:"Additional layers and Resources"})}),"\n"]})]})}function l(t={}){const{wrapper:e}={...(0,r.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(u,{...t})}):u(t)}},28453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>i});var n=o(96540);const s={},r=n.createContext(s);function a(t){const e=n.useContext(r);return n.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function i(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(s):t.components||s:a(t.components),n.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/171dad78.ee0af3d7.js b/assets/js/171dad78.ee0af3d7.js new file mode 100644 index 0000000000..d3b41cd0ce --- /dev/null +++ b/assets/js/171dad78.ee0af3d7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5874],{95148:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"started/before_you_get_started","title":"Before you get started","description":"A great starting point for those absolutely new to Rucio, this section aims to","source":"@site/../docs/started/before_you_get_started.md","sourceDirName":"started","slug":"/started/before_you_get_started","permalink":"/documentation/started/before_you_get_started","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/before_you_get_started.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"before_you_get_started","title":"Before you get started"},"sidebar":"docs","previous":{"title":"Welcome","permalink":"/documentation/"},"next":{"title":"What is Rucio?","permalink":"/documentation/started/what_is_rucio"}}');var s=o(74848),r=o(28453);const a={id:"before_you_get_started",title:"Before you get started"},i=void 0,d={},c=[];function u(t){const e={a:"a",li:"li",p:"p",ul:"ul",...(0,r.R)(),...t.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.p,{children:"A great starting point for those absolutely new to Rucio, this section aims to\nhelps you understand the basics of our Data Management system. The motivations\nbehind this project, what we are looking to achieve, & what we have done so far\nare some of the points covered in this section."}),"\n",(0,s.jsxs)(e.ul,{children:["\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/what_is_rucio",children:"What is Rucio?"})}),"\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/main_components",children:"Main Components"})}),"\n",(0,s.jsx)(e.li,{children:(0,s.jsx)(e.a,{href:"/documentation/started/additional_layers_and_resources",children:"Additional layers and Resources"})}),"\n"]})]})}function l(t={}){const{wrapper:e}={...(0,r.R)(),...t.components};return e?(0,s.jsx)(e,{...t,children:(0,s.jsx)(u,{...t})}):u(t)}},28453:(t,e,o)=>{o.d(e,{R:()=>a,x:()=>i});var n=o(96540);const s={},r=n.createContext(s);function a(t){const e=n.useContext(r);return n.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function i(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(s):t.components||s:a(t.components),n.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a726a41.a45dfd75.js b/assets/js/1a726a41.a45dfd75.js deleted file mode 100644 index 42cfa486d6..0000000000 --- a/assets/js/1a726a41.a45dfd75.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[9252],{90218:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"started/main_components","title":"Main Components","description":"Rucio is based on a distributed system architecture & can be sectioned into four","source":"@site/../docs/started/main_components.md","sourceDirName":"started","slug":"/started/main_components","permalink":"/documentation/started/main_components","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/main_components.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"main_components","title":"Main Components"},"sidebar":"docs","previous":{"title":"What is Rucio?","permalink":"/documentation/started/what_is_rucio"},"next":{"title":"Additional Layers and Resources","permalink":"/documentation/started/additional_layers_and_resources"}}');var i=t(74848),o=t(28453);const a={id:"main_components",title:"Main Components"},r=void 0,c={},d=[{value:"Clients",id:"clients",level:2},{value:"Server",id:"server",level:2},{value:"Core",id:"core",level:2},{value:"Daemons",id:"daemons",level:2}];function l(e){const n={a:"a",h2:"h2",img:"img",p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"Rucio is based on a distributed system architecture & can be sectioned into four\nmajor layers:"}),"\n",(0,i.jsx)(n.h2,{id:"clients",children:"Clients"}),"\n",(0,i.jsx)(n.p,{children:"The clients layer consists of components such as the command line clients (CLI),\nPython clients, and the Javascript-based web user interface and configuration."}),"\n",(0,i.jsx)(n.h2,{id:"server",children:"Server"}),"\n",(0,i.jsx)(n.p,{children:"The server layer serves the purpose of authentication & provides a common API\nfor interaction with clients & other external application, as also the Web UI."}),"\n",(0,i.jsx)(n.h2,{id:"core",children:"Core"}),"\n",(0,i.jsx)(n.p,{children:"This layer consists of all the Rucio-level abstractions that are explained at\nlength in the Concepts section."}),"\n",(0,i.jsx)(n.h2,{id:"daemons",children:"Daemons"}),"\n",(0,i.jsx)(n.p,{children:"The daemons layer takes care of all the asynchronous & continuous workflows in\nthe background."}),"\n",(0,i.jsx)(n.p,{children:"A diagrammatic representation of the 4 layers is as shown below"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(81966).A+"",width:"513",height:"452"})}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about each of these layers in detail, download our ",(0,i.jsx)(n.a,{href:"https://link.springer.com/article/10.1007/s41781-019-0026-3",children:"peer reviewed\nscientific paper"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},81966:(e,n,t)=>{t.d(n,{A:()=>s});const s=t.p+"assets/images/architecture-a407801cb690fc1a73a930e2691f761f.png"},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(96540);const i={},o=s.createContext(i);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a726a41.d3b9d461.js b/assets/js/1a726a41.d3b9d461.js new file mode 100644 index 0000000000..37577e48fd --- /dev/null +++ b/assets/js/1a726a41.d3b9d461.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[9252],{90218:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"started/main_components","title":"Main Components","description":"Rucio is based on a distributed system architecture & can be sectioned into four","source":"@site/../docs/started/main_components.md","sourceDirName":"started","slug":"/started/main_components","permalink":"/documentation/started/main_components","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/main_components.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"main_components","title":"Main Components"},"sidebar":"docs","previous":{"title":"What is Rucio?","permalink":"/documentation/started/what_is_rucio"},"next":{"title":"Additional Layers and Resources","permalink":"/documentation/started/additional_layers_and_resources"}}');var o=t(74848),i=t(28453);const a={id:"main_components",title:"Main Components"},r=void 0,c={},d=[{value:"Clients",id:"clients",level:2},{value:"Server",id:"server",level:2},{value:"Core",id:"core",level:2},{value:"Daemons",id:"daemons",level:2}];function l(e){const n={a:"a",h2:"h2",img:"img",p:"p",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Rucio is based on a distributed system architecture & can be sectioned into four\nmajor layers:"}),"\n",(0,o.jsx)(n.h2,{id:"clients",children:"Clients"}),"\n",(0,o.jsx)(n.p,{children:"The clients layer consists of components such as the command line clients (CLI),\nPython clients, and the Javascript-based web user interface and configuration."}),"\n",(0,o.jsx)(n.h2,{id:"server",children:"Server"}),"\n",(0,o.jsx)(n.p,{children:"The server layer serves the purpose of authentication & provides a common API\nfor interaction with clients & other external application, as also the Web UI."}),"\n",(0,o.jsx)(n.h2,{id:"core",children:"Core"}),"\n",(0,o.jsx)(n.p,{children:"This layer consists of all the Rucio-level abstractions that are explained at\nlength in the Concepts section."}),"\n",(0,o.jsx)(n.h2,{id:"daemons",children:"Daemons"}),"\n",(0,o.jsx)(n.p,{children:"The daemons layer takes care of all the asynchronous & continuous workflows in\nthe background."}),"\n",(0,o.jsx)(n.p,{children:"A diagrammatic representation of the 4 layers is as shown below"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"image",src:t(81966).A+"",width:"513",height:"452"})}),"\n",(0,o.jsxs)(n.p,{children:["To learn more about each of these layers in detail, download our ",(0,o.jsx)(n.a,{href:"https://link.springer.com/article/10.1007/s41781-019-0026-3",children:"peer reviewed\nscientific paper"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},81966:(e,n,t)=>{t.d(n,{A:()=>s});const s=t.p+"assets/images/architecture-a407801cb690fc1a73a930e2691f761f.png"},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(96540);const o={},i=s.createContext(o);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ae78d49.2de23451.js b/assets/js/1ae78d49.2de23451.js deleted file mode 100644 index 2fb1f6b9d4..0000000000 --- a/assets/js/1ae78d49.2de23451.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6552],{78760:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"contact_us","title":"Contact us","description":"We know getting started can be difficult, which is why","source":"@site/../docs/contact_us.md","sourceDirName":".","slug":"/contact_us","permalink":"/documentation/contact_us","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/contact_us.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"contact_us","title":"Contact us"},"sidebar":"docs","previous":{"title":"About Our Contributors","permalink":"/documentation/about_our_contributors"}}');var o=n(74848),s=n(28453);const c={id:"contact_us",title:"Contact us"},a=void 0,r={},u=[{value:"Chat with us",id:"chat-with-us",level:2},{value:"Weekly Rucio meeting",id:"weekly-rucio-meeting",level:2},{value:"Rucio news mailing list",id:"rucio-news-mailing-list",level:2},{value:"Email us",id:"email-us",level:2},{value:"Social Media",id:"social-media",level:2}];function l(e){const t={a:"a",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"We know getting started can be difficult, which is why\nour developers are always happy to help out! Reach out\nto us on any of the below channels for any assistance\nwith Rucio."}),"\n",(0,o.jsx)(t.h2,{id:"chat-with-us",children:"Chat with us"}),"\n",(0,o.jsxs)(t.p,{children:["We have a dedicated Mattermost team for questions, support, news, development\nupdates and all things Rucio and you can be a part of it too!\nClick ",(0,o.jsx)(t.a,{href:"/documentation/join_rucio_mattermost",children:"here"})]}),"\n",(0,o.jsx)(t.h2,{id:"weekly-rucio-meeting",children:"Weekly Rucio meeting"}),"\n",(0,o.jsxs)(t.p,{children:["The Rucio community gathers for a meeting every Thursday at 3 PM CEST to discuss\ncommunity news, operational issues and questions, as well as ongoing & further\ncontributions by the development team. The meeting is open to the public\nand you can view the schedule ",(0,o.jsx)(t.a,{href:"https://indico.cern.ch/category/10588/",children:"here"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"rucio-news-mailing-list",children:"Rucio news mailing list"}),"\n",(0,o.jsxs)(t.p,{children:["We have a dedicated news mailing list for general announcements (<10 eMails per\nyear) for the Rucio community. You can subscribe to ",(0,o.jsx)(t.a,{href:"https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10586148",children:"rucio-news@cern.ch"}),"\ndirectly with a CERN account, for external subscribers please send an eMail\nto ",(0,o.jsx)(t.a,{href:"mailto:rucio-news-subscribe@cern.ch?subject=Subscribe",children:"rucio-news-subscribe@cern.ch"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"email-us",children:"Email us"}),"\n",(0,o.jsxs)(t.p,{children:["We'd love to hear from you! Get in contact with us\ndirectly via ",(0,o.jsx)(t.a,{href:"mailto:rucio-contact@cern.ch",children:"email"})]}),"\n",(0,o.jsx)(t.h2,{id:"social-media",children:"Social Media"}),"\n",(0,o.jsxs)(t.p,{children:["Follow us on ",(0,o.jsx)(t.a,{href:"https://fosstodon.org/@rucio",children:"Mastodon"})," to stay updated\nwith the latest on Rucio!"]})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var i=n(96540);const o={},s=i.createContext(o);function c(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ae78d49.d285c9c8.js b/assets/js/1ae78d49.d285c9c8.js new file mode 100644 index 0000000000..e180397118 --- /dev/null +++ b/assets/js/1ae78d49.d285c9c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6552],{78760:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>u});const i=JSON.parse('{"id":"contact_us","title":"Contact us","description":"We know getting started can be difficult, which is why","source":"@site/../docs/contact_us.md","sourceDirName":".","slug":"/contact_us","permalink":"/documentation/contact_us","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/contact_us.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"contact_us","title":"Contact us"},"sidebar":"docs","previous":{"title":"About Our Contributors","permalink":"/documentation/about_our_contributors"}}');var o=n(74848),s=n(28453);const c={id:"contact_us",title:"Contact us"},a=void 0,r={},u=[{value:"Chat with us",id:"chat-with-us",level:2},{value:"Weekly Rucio meeting",id:"weekly-rucio-meeting",level:2},{value:"Rucio news mailing list",id:"rucio-news-mailing-list",level:2},{value:"Email us",id:"email-us",level:2},{value:"Social Media",id:"social-media",level:2}];function l(e){const t={a:"a",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"We know getting started can be difficult, which is why\nour developers are always happy to help out! Reach out\nto us on any of the below channels for any assistance\nwith Rucio."}),"\n",(0,o.jsx)(t.h2,{id:"chat-with-us",children:"Chat with us"}),"\n",(0,o.jsxs)(t.p,{children:["We have a dedicated Mattermost team for questions, support, news, development\nupdates and all things Rucio and you can be a part of it too!\nClick ",(0,o.jsx)(t.a,{href:"/documentation/join_rucio_mattermost",children:"here"})]}),"\n",(0,o.jsx)(t.h2,{id:"weekly-rucio-meeting",children:"Weekly Rucio meeting"}),"\n",(0,o.jsxs)(t.p,{children:["The Rucio community gathers for a meeting every Thursday at 3 PM CEST to discuss\ncommunity news, operational issues and questions, as well as ongoing & further\ncontributions by the development team. The meeting is open to the public\nand you can view the schedule ",(0,o.jsx)(t.a,{href:"https://indico.cern.ch/category/10588/",children:"here"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"rucio-news-mailing-list",children:"Rucio news mailing list"}),"\n",(0,o.jsxs)(t.p,{children:["We have a dedicated news mailing list for general announcements (<10 eMails per\nyear) for the Rucio community. You can subscribe to ",(0,o.jsx)(t.a,{href:"https://e-groups.cern.ch/e-groups/Egroup.do?egroupId=10586148",children:"rucio-news@cern.ch"}),"\ndirectly with a CERN account, for external subscribers please send an eMail\nto ",(0,o.jsx)(t.a,{href:"mailto:rucio-news-subscribe@cern.ch?subject=Subscribe",children:"rucio-news-subscribe@cern.ch"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"email-us",children:"Email us"}),"\n",(0,o.jsxs)(t.p,{children:["We'd love to hear from you! Get in contact with us\ndirectly via ",(0,o.jsx)(t.a,{href:"mailto:rucio-contact@cern.ch",children:"email"})]}),"\n",(0,o.jsx)(t.h2,{id:"social-media",children:"Social Media"}),"\n",(0,o.jsxs)(t.p,{children:["Follow us on ",(0,o.jsx)(t.a,{href:"https://fosstodon.org/@rucio",children:"Mastodon"})," to stay updated\nwith the latest on Rucio!"]})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var i=n(96540);const o={},s=i.createContext(o);function c(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1b18b8b2.2ecc0b5c.js b/assets/js/1b18b8b2.2ecc0b5c.js new file mode 100644 index 0000000000..5e2d853a40 --- /dev/null +++ b/assets/js/1b18b8b2.2ecc0b5c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8939],{78780:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"started/requirements","title":"Requirements","description":"Rucio relies on several dependencies, some of them being a hard requirement,","source":"@site/../docs/started/requirements.md","sourceDirName":"started","slug":"/started/requirements","permalink":"/documentation/started/requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/requirements.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"requirements","title":"Requirements","sidebar_label":"Requirements"},"sidebar":"docs","previous":{"title":"Additional Layers and Resources","permalink":"/documentation/started/additional_layers_and_resources"},"next":{"title":"Rucio account","permalink":"/documentation/started/concepts/rucio_account"}}');var s=n(74848),i=n(28453);const d={id:"requirements",title:"Requirements",sidebar_label:"Requirements"},o=void 0,c={},a=[{value:"Python",id:"python",level:2},{value:"Database",id:"database",level:2}];function l(e){const t={a:"a",code:"code",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Rucio relies on several dependencies, some of them being a hard requirement,\nothers being optional depending on the used Rucio functionality."}),"\n",(0,s.jsxs)(t.p,{children:["To install Rucio, we generally recommend a Kubernetes-based deployment based on\nour ",(0,s.jsx)(t.a,{href:"https://github.com/rucio/helm-charts",children:"helm-charts"}),". A direct deployment\nusing Rucio ",(0,s.jsx)(t.a,{href:"https://hub.docker.com/u/rucio",children:"docker containers"}),", or Rucio\n",(0,s.jsx)(t.a,{href:"https://pypi.org/project/rucio/",children:"pip"})," packages is also possible."]}),"\n",(0,s.jsx)(t.h2,{id:"python",children:"Python"}),"\n",(0,s.jsx)(t.p,{children:"Rucio server, daemons and clients are written in Python and thus depend on an\ninstalled Python interpreter."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Rucio release"}),(0,s.jsx)(t.th,{children:"Supported python versions"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/release-notes/1.29.0",children:"1.29 LTS"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:">=3.6, <=3.9"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsxs)(t.td,{children:["from ",(0,s.jsx)(t.a,{href:"/release-notes/32.0.0",children:"32 LTS"})]}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:">=3.9, <=3.10"})})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"database",children:"Database"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Database"}),(0,s.jsx)(t.th,{children:"Supported version"}),(0,s.jsx)(t.th,{children:"Note"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SQLite"}),(0,s.jsx)(t.td,{children:"3+"}),(0,s.jsx)(t.td,{children:"For testing only"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"MySQL"}),(0,s.jsx)(t.td,{children:"8"}),(0,s.jsx)(t.td,{children:"No support for SSH public key authentication"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PostgreSQL"}),(0,s.jsx)(t.td,{children:"12 and higher"}),(0,s.jsx)(t.td,{})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"Oracle"}),(0,s.jsx)(t.td,{children:"19c"}),(0,s.jsx)(t.td,{})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>d,x:()=>o});var r=n(96540);const s={},i=r.createContext(s);function d(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1b18b8b2.95f65a8a.js b/assets/js/1b18b8b2.95f65a8a.js deleted file mode 100644 index dc67238801..0000000000 --- a/assets/js/1b18b8b2.95f65a8a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8939],{78780:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"started/requirements","title":"Requirements","description":"Rucio relies on several dependencies, some of them being a hard requirement,","source":"@site/../docs/started/requirements.md","sourceDirName":"started","slug":"/started/requirements","permalink":"/documentation/started/requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/requirements.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"requirements","title":"Requirements","sidebar_label":"Requirements"},"sidebar":"docs","previous":{"title":"Additional Layers and Resources","permalink":"/documentation/started/additional_layers_and_resources"},"next":{"title":"Rucio account","permalink":"/documentation/started/concepts/rucio_account"}}');var s=n(74848),i=n(28453);const d={id:"requirements",title:"Requirements",sidebar_label:"Requirements"},o=void 0,c={},a=[{value:"Python",id:"python",level:2},{value:"Database",id:"database",level:2}];function l(e){const t={a:"a",code:"code",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Rucio relies on several dependencies, some of them being a hard requirement,\nothers being optional depending on the used Rucio functionality."}),"\n",(0,s.jsxs)(t.p,{children:["To install Rucio, we generally recommend a Kubernetes-based deployment based on\nour ",(0,s.jsx)(t.a,{href:"https://github.com/rucio/helm-charts",children:"helm-charts"}),". A direct deployment\nusing Rucio ",(0,s.jsx)(t.a,{href:"https://hub.docker.com/u/rucio",children:"docker containers"}),", or Rucio\n",(0,s.jsx)(t.a,{href:"https://pypi.org/project/rucio/",children:"pip"})," packages is also possible."]}),"\n",(0,s.jsx)(t.h2,{id:"python",children:"Python"}),"\n",(0,s.jsx)(t.p,{children:"Rucio server, daemons and clients are written in Python and thus depend on an\ninstalled Python interpreter."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Rucio release"}),(0,s.jsx)(t.th,{children:"Supported python versions"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"/release-notes/1.29.0",children:"1.29 LTS"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:">=3.6, <=3.9"})})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsxs)(t.td,{children:["from ",(0,s.jsx)(t.a,{href:"/release-notes/32.0.0",children:"32 LTS"})]}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:">=3.9, <=3.10"})})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"database",children:"Database"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Database"}),(0,s.jsx)(t.th,{children:"Supported version"}),(0,s.jsx)(t.th,{children:"Note"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SQLite"}),(0,s.jsx)(t.td,{children:"3+"}),(0,s.jsx)(t.td,{children:"For testing only"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"MySQL"}),(0,s.jsx)(t.td,{children:"8"}),(0,s.jsx)(t.td,{children:"No support for SSH public key authentication"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"PostgreSQL"}),(0,s.jsx)(t.td,{children:"12 and higher"}),(0,s.jsx)(t.td,{})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"Oracle"}),(0,s.jsx)(t.td,{children:"19c"}),(0,s.jsx)(t.td,{})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>d,x:()=>o});var r=n(96540);const s={},i=r.createContext(s);function d(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1baa3d0c.135b5325.js b/assets/js/1baa3d0c.135b5325.js new file mode 100644 index 0000000000..186f82507c --- /dev/null +++ b/assets/js/1baa3d0c.135b5325.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4390],{1469:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"operator/administration","title":"Rucio Administration Tricks","description":"Rucio container code hot-patching","source":"@site/../docs/operator/administration.md","sourceDirName":"operator","slug":"/operator/administration","permalink":"/documentation/operator/administration","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/administration.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"administration","title":"Rucio Administration Tricks","sidebar_label":"Administration Tricks"},"sidebar":"docs","previous":{"title":"Database Operations","permalink":"/documentation/operator/database"},"next":{"title":"Configuration parameters","permalink":"/documentation/operator/configuration_parameters"}}');var o=n(74848),i=n(28453);const a={id:"administration",title:"Rucio Administration Tricks",sidebar_label:"Administration Tricks"},c=void 0,s={},l=[{value:"Rucio container code hot-patching",id:"rucio-container-code-hot-patching",level:2},{value:"Creating a patch from existing pull request",id:"creating-a-patch-from-existing-pull-request",level:3},{value:"Mounting a patch in a kubernetes cluster",id:"mounting-a-patch-in-a-kubernetes-cluster",level:3}];function h(e){const t={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"rucio-container-code-hot-patching",children:"Rucio container code hot-patching"}),"\n",(0,o.jsx)(t.p,{children:"The rucio official containers provide a way to hotpatch the source code\nbefore running rucio. This behavior may be used to rapidly fix a production\ndeployment without having to wait for the change to be merged and released by\nthe rucio team."}),"\n",(0,o.jsxs)(t.p,{children:["The behavior is very simple: any file found in the ",(0,o.jsx)(t.code,{children:"/patch/*"})," directory inside\nthe containers will be fed to the ",(0,o.jsx)(t.code,{children:"patch"})," command-line tool in the order\nreturned by this glob matching."]}),"\n",(0,o.jsx)(t.p,{children:"The procedures described bellow are only intended for temporary fixes. If a\npermanent change is needed, we highly encourage you to open a pull request\nin rucio to spare you the toil related to maintaining your own local patch set."}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-patch-from-existing-pull-request",children:"Creating a patch from existing pull request"}),"\n",(0,o.jsxs)(t.p,{children:["Lets assume you run rucio ",(0,o.jsx)(t.code,{children:"1.27.3"})," in production, and you realize there is\na bug in the ",(0,o.jsx)(t.code,{children:"conveyor-poller"})," daemon. You contact the rucio team and are\ntold that a fix was already done in the pull request\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/rucio/pull/5246/commits",children:"#5246"}),"\nand will be released next week. Follow\nthe following steps to create a patch file from this pull request without\nhaving to wait for the next rucio release to fix your issue:"]}),"\n",(0,o.jsx)(t.p,{children:"Clone the main rucio repository:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git clone https://github.com/rucio/rucio.git\ncd rucio\n# Create a new branch from the 1.27.3 release tag\ngit checkout 1.27.3 -b patch-0-hotfix_conveyor_poller_on_1.27.3\n"})}),"\n",(0,o.jsxs)(t.p,{children:["The #5246 pull request was submitted by the user ",(0,o.jsx)(t.code,{children:"rcarpa"})," from his rucio\nfork ",(0,o.jsx)(t.a,{href:"https://github.com/rcarpa/rucio",children:"rcarpa/rucio"}),". You'll have to add\nthis fork repository as a git remote:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git remote add rcarpa https://github.com/rcarpa/rucio.git\ngit fetch rcarpa\n# Cherry-pick the commit from the #5246 pull request.\n# Beware, some PR can have multiple commits\ngit cherry-pick 47d36345469ac9c1391cacd09487d4ec6ced627f\n"})}),"\n",(0,o.jsx)(t.p,{children:"Now you can create the patch with the differences between the rucio 1.27.3\nrelease and the current state of the repository:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git diff 1.27.3 > hotfix_conveyor_poller.patch\n"})}),"\n",(0,o.jsx)(t.h3,{id:"mounting-a-patch-in-a-kubernetes-cluster",children:"Mounting a patch in a kubernetes cluster"}),"\n",(0,o.jsxs)(t.p,{children:["If you deploy rucio in a kubernetes cluster using the official rucio\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/helm-charts/",children:"helm charts"})," and want to hotfix\nrucio using a patch file created in the previous section, follow these steps:"]}),"\n",(0,o.jsx)(t.p,{children:"Create a kubernetes secret from the hotfix patch:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"kubectl -n rucio create secret generic hotfix-conveyor-poller-patch --from-file=hotfix_conveyor_poller.patch\n"})}),"\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.em,{children:"Note:"})," if you have more than one cluster, don't forget to create the\nsecrets in each cluster to be patched."]}),"\n",(0,o.jsxs)(t.p,{children:["Now you'll have to update the helm ",(0,o.jsx)(t.code,{children:"values"})," file for each helm release and\nadd the following"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-yaml",children:" secretMounts:\n - secretFullName: hotfix-conveyor-poller-patch\n mountPath: /patch/hotfix_conveyor_poller.patch\n subPath: hotfix_conveyor_poller.patch\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(96540);const o={},i=r.createContext(o);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1baa3d0c.bea4d296.js b/assets/js/1baa3d0c.bea4d296.js deleted file mode 100644 index a41fe92e7b..0000000000 --- a/assets/js/1baa3d0c.bea4d296.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4390],{1469:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"operator/administration","title":"Rucio Administration Tricks","description":"Rucio container code hot-patching","source":"@site/../docs/operator/administration.md","sourceDirName":"operator","slug":"/operator/administration","permalink":"/documentation/operator/administration","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/administration.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"administration","title":"Rucio Administration Tricks","sidebar_label":"Administration Tricks"},"sidebar":"docs","previous":{"title":"Database Operations","permalink":"/documentation/operator/database"},"next":{"title":"Configuration parameters","permalink":"/documentation/operator/configuration_parameters"}}');var o=n(74848),i=n(28453);const a={id:"administration",title:"Rucio Administration Tricks",sidebar_label:"Administration Tricks"},c=void 0,s={},l=[{value:"Rucio container code hot-patching",id:"rucio-container-code-hot-patching",level:2},{value:"Creating a patch from existing pull request",id:"creating-a-patch-from-existing-pull-request",level:3},{value:"Mounting a patch in a kubernetes cluster",id:"mounting-a-patch-in-a-kubernetes-cluster",level:3}];function h(e){const t={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"rucio-container-code-hot-patching",children:"Rucio container code hot-patching"}),"\n",(0,o.jsx)(t.p,{children:"The rucio official containers provide a way to hotpatch the source code\nbefore running rucio. This behavior may be used to rapidly fix a production\ndeployment without having to wait for the change to be merged and released by\nthe rucio team."}),"\n",(0,o.jsxs)(t.p,{children:["The behavior is very simple: any file found in the ",(0,o.jsx)(t.code,{children:"/patch/*"})," directory inside\nthe containers will be fed to the ",(0,o.jsx)(t.code,{children:"patch"})," command-line tool in the order\nreturned by this glob matching."]}),"\n",(0,o.jsx)(t.p,{children:"The procedures described bellow are only intended for temporary fixes. If a\npermanent change is needed, we highly encourage you to open a pull request\nin rucio to spare you the toil related to maintaining your own local patch set."}),"\n",(0,o.jsx)(t.h3,{id:"creating-a-patch-from-existing-pull-request",children:"Creating a patch from existing pull request"}),"\n",(0,o.jsxs)(t.p,{children:["Lets assume you run rucio ",(0,o.jsx)(t.code,{children:"1.27.3"})," in production, and you realize there is\na bug in the ",(0,o.jsx)(t.code,{children:"conveyor-poller"})," daemon. You contact the rucio team and are\ntold that a fix was already done in the pull request\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/rucio/pull/5246/commits",children:"#5246"}),"\nand will be released next week. Follow\nthe following steps to create a patch file from this pull request without\nhaving to wait for the next rucio release to fix your issue:"]}),"\n",(0,o.jsx)(t.p,{children:"Clone the main rucio repository:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git clone https://github.com/rucio/rucio.git\ncd rucio\n# Create a new branch from the 1.27.3 release tag\ngit checkout 1.27.3 -b patch-0-hotfix_conveyor_poller_on_1.27.3\n"})}),"\n",(0,o.jsxs)(t.p,{children:["The #5246 pull request was submitted by the user ",(0,o.jsx)(t.code,{children:"rcarpa"})," from his rucio\nfork ",(0,o.jsx)(t.a,{href:"https://github.com/rcarpa/rucio",children:"rcarpa/rucio"}),". You'll have to add\nthis fork repository as a git remote:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git remote add rcarpa https://github.com/rcarpa/rucio.git\ngit fetch rcarpa\n# Cherry-pick the commit from the #5246 pull request.\n# Beware, some PR can have multiple commits\ngit cherry-pick 47d36345469ac9c1391cacd09487d4ec6ced627f\n"})}),"\n",(0,o.jsx)(t.p,{children:"Now you can create the patch with the differences between the rucio 1.27.3\nrelease and the current state of the repository:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"git diff 1.27.3 > hotfix_conveyor_poller.patch\n"})}),"\n",(0,o.jsx)(t.h3,{id:"mounting-a-patch-in-a-kubernetes-cluster",children:"Mounting a patch in a kubernetes cluster"}),"\n",(0,o.jsxs)(t.p,{children:["If you deploy rucio in a kubernetes cluster using the official rucio\n",(0,o.jsx)(t.a,{href:"https://github.com/rucio/helm-charts/",children:"helm charts"})," and want to hotfix\nrucio using a patch file created in the previous section, follow these steps:"]}),"\n",(0,o.jsx)(t.p,{children:"Create a kubernetes secret from the hotfix patch:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"kubectl -n rucio create secret generic hotfix-conveyor-poller-patch --from-file=hotfix_conveyor_poller.patch\n"})}),"\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.em,{children:"Note:"})," if you have more than one cluster, don't forget to create the\nsecrets in each cluster to be patched."]}),"\n",(0,o.jsxs)(t.p,{children:["Now you'll have to update the helm ",(0,o.jsx)(t.code,{children:"values"})," file for each helm release and\nadd the following"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-yaml",children:" secretMounts:\n - secretFullName: hotfix-conveyor-poller-patch\n mountPath: /patch/hotfix_conveyor_poller.patch\n subPath: hotfix_conveyor_poller.patch\n"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var r=n(96540);const o={},i=r.createContext(o);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1cb64aec.4d6b7ec3.js b/assets/js/1cb64aec.4d6b7ec3.js deleted file mode 100644 index 95914e81eb..0000000000 --- a/assets/js/1cb64aec.4d6b7ec3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2830],{8256:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"client_api/touchclient","title":"TouchClient","description":"touch","source":"@site/../docs/client_api/touchclient.md","sourceDirName":"client_api","slug":"/client_api/touchclient","permalink":"/documentation/client_api/touchclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/touchclient.md","tags":[],"version":"current","frontMatter":{"title":"TouchClient"},"sidebar":"docs","previous":{"title":"SubscriptionClient","permalink":"/documentation/client_api/subscriptionclient"},"next":{"title":"UploadClient","permalink":"/documentation/client_api/uploadclient"}}');var c=n(74848),i=n(28453);const r={title:"TouchClient"},s=void 0,l={},d=[{value:"touch",id:"touch",level:2}];function a(e){const t={code:"code",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.h2,{id:"touch",children:"touch"}),"\n",(0,c.jsxs)("span",{style:{"white-space":"pre"},children:[(0,c.jsx)(t.p,{children:"Sends a touch trace for a given file or dataset."}),(0,c.jsx)("table",{style:{border:"none"},children:(0,c.jsxs)("tbody",{children:[(0,c.jsxs)("tr",{style:{border:"none"},children:[(0,c.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.strong,{children:"Arguments"}),":"]})}),(0,c.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"scope"}),": the scope of the file/dataset to update."]}),(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"name"}),": the name of file/dataset to update."]}),(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"rse"}),": optional parameter if a specific replica should be touched."]})]})]}),(0,c.jsxs)("tr",{style:{border:"none"},children:[(0,c.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.strong,{children:"Raises"}),":"]})}),(0,c.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"DataIdentifierNotFound"}),": if given dids does not exist."]}),(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"RSENotFound"}),": if rse is not None and given rse does not exist."]}),(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"UnsupportedDIDType"}),": if type of the given DID is not FILE or DATASET."]}),(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"RucioException"}),": if trace could not be sent successfully."]})]})]})]})})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>s});var o=n(96540);const c={},i=o.createContext(c);function r(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f6323a9.6c16ba52.js b/assets/js/1f6323a9.6c16ba52.js new file mode 100644 index 0000000000..5858b8547c --- /dev/null +++ b/assets/js/1f6323a9.6c16ba52.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6068],{34369:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"developer/webui/streamedtables","title":"Using the WebUI StreamedTable Component","description":"Data presentation in the WebUI","source":"@site/../docs/developer/webui/streamedtables.md","sourceDirName":"developer/webui","slug":"/developer/webui/streamedtables","permalink":"/documentation/developer/webui/streamedtables","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/webui/streamedtables.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"streamedtables","title":"Using the WebUI StreamedTable Component"},"sidebar":"docs","previous":{"title":"Setting up a WebUI Developer Environment using Visual Studio Code","permalink":"/documentation/developer/webui/webui_frontend_vscode_dev_env"},"next":{"title":"Developing the WebUI Frontend","permalink":"/documentation/developer/webui/webui_frontend"}}');var s=t(74848),a=t(28453);const l={id:"streamedtables",title:"Using the WebUI StreamedTable Component"},o=void 0,r={},c=[{value:"Data presentation in the WebUI",id:"data-presentation-in-the-webui",level:2},{value:"StreamedTable",id:"streamedtable",level:2},{value:"TableColumns",id:"tablecolumns",level:3},{value:"Common components for column headers",id:"common-components-for-column-headers",level:3},{value:"TableSortUpDown",id:"tablesortupdown",level:4},{value:"TableFilterDiscrete",id:"tablefilterdiscrete",level:4},{value:"TableFilterBoolean",id:"tablefilterboolean",level:4},{value:"TableFilterString",id:"tablefilterstring",level:4},{value:"Common components for column cells",id:"common-components-for-column-cells",level:3},{value:"TableStyling",id:"tablestyling",level:3},{value:"Setting column widths",id:"setting-column-widths",level:3},{value:"TableSelecting",id:"tableselecting",level:3},{value:"NormalTable",id:"normaltable",level:3},{value:"StreamedTable in the context of NextJS",id:"streamedtable-in-the-context-of-nextjs",level:2},{value:"QueryClientProvider",id:"queryclientprovider",level:4},{value:"Route",id:"route",level:4}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"data-presentation-in-the-webui",children:"Data presentation in the WebUI"}),"\n",(0,s.jsx)(n.p,{children:'An issue we encountered in the process of developing the WebUI which is\nparticularly relevant in the context of writing a Rucio frontend is streaming.\nThe "old" web frontend (which we want to replace) had the issue that it would\nfreeze on starting larger queries, with no indication as to the progress made or\npotential errors encountered. Even when everything worked well, these "freezes"\ncould last for up to several minutes in which the page was effectively unusable.'}),"\n",(0,s.jsx)(n.p,{children:"The reason for this was the fact that any responses from the Rucio server (which\nsupports streaming) were stored in a WebUI intermediary, before being forwarded\nto the client in one batch. Since Rucio responses can be huge (and often, there\nis no prior indication of the size which a query will take), this could lead to\nfreezing of unknown duration."}),"\n",(0,s.jsxs)(n.p,{children:["The solution would be to pass the stream from Rucio through the WebUI\nbackend/core to the frontend. This required special software engineering on the\nbackend, which shall not be covered here. The frontend accesses the streams via\na system called the ",(0,s.jsx)(n.code,{children:"ComDOM"}),", short for ",(0,s.jsx)(n.code,{children:"Communication Document Object Model"}),".\nIt accesses the streams provided by the backend API layer (and NOT the Rucio\nserver itself) and wraps the data with further tooling (to start/pause/stop the\nstream, inspect the state, etc.)."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Streamed data is unavoidable in the WebUI. The UI accesses this data in the form\nof the ",(0,s.jsx)(n.code,{children:"ComDOM"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["The generic component when dealing with streamed data is the ",(0,s.jsx)(n.code,{children:"StreamedTable"}),",\nwhich is a custom HTML table framework based on ",(0,s.jsx)(n.a,{href:"https://tanstack.com/table/v8/docs/introduction",children:"Tanstack\nTable"})," and optimized for\nuse with the streams fed in via the ComDOM. A StreamedTable is defined by a set\nof react props passed into the component (which will be described below). The\nframework is completed by a plethora of ready-to-use components which solve the\nmajority of required usecases when it comes to streamed tables."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"StreamedTable Example",src:t(2119).A+"",width:"892",height:"456"})}),"\n",(0,s.jsx)(n.h2,{id:"streamedtable",children:"StreamedTable"}),"\n",(0,s.jsxs)(n.p,{children:["The StreamedTable is a fully typed react component based on the HTML ",(0,s.jsx)(n.code,{children:"table"})," element. The props it takes are defined in the codeblock below."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'type StreamedTableProps = JSX.IntrinsicElements["table"] & {\n tablecomdom: UseComDOM\n tablecolumns: any[]\n tablestyling?: TableStyling\n tableselecting?: TableSelecting\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The table expects a stream of elements of type ",(0,s.jsx)(n.code,{children:"T"}),", where ",(0,s.jsx)(n.code,{children:"T"})," extends the\n",(0,s.jsx)(n.code,{children:"BaseViewModel"}),". In practice, this means that an entity is wrapped in an object\nproviding status and an optional errormessage."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The data shown by the table is passed into the ",(0,s.jsx)(n.code,{children:"tablecomdom"})," prop as an\n",(0,s.jsx)(n.code,{children:"UseComDOM"})," object. This object also provides functions to inspect and control\nthe stream. The generic ",(0,s.jsx)(n.code,{children:"UseComDOM"})," type is bound to type ",(0,s.jsx)(n.code,{children:"T"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The table structure (i.e. the way data is structured into columns) is defined\nby the ",(0,s.jsx)(n.code,{children:"tablecolumns"})," prop. This is essentially an array of column definition\nobjects (which are taken from Tanstack Table), but there are exceptions, which\nmake typing this prop difficult. Most of your time building a streamedtable is\nspent writing this definition."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The first optional prop, ",(0,s.jsx)(n.code,{children:"tablestyling"})," is a structure containing style\ncommands for the table. The definition of the ",(0,s.jsx)(n.code,{children:"TableStyling"})," type is given\nbelow."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"tableselecting"}),' optionally defines how the user can select (single- or\nmulti-select) elements from the table. It also controls the "breakout"\nfunctionality. This is discussed later.']}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:'JSX.IntrinsicElements["table"]'})," means that the StreamedTable component will\nreturn a react component with the HTML ",(0,s.jsx)(n.code,{children:""})," tag as its top-level component,\nwhich in turn means that any valid HTML table-properties can be passed to the\nStreamedTable, and these will be passed on to the top-level component. This\nspecifically also includes styling the top-level ",(0,s.jsx)(n.code,{children:"
    "})," via ",(0,s.jsx)(n.code,{children:"className"})," but\nalso ARIA-properties."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"tablecolumns",children:"TableColumns"}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"When creating a new component or editing a new one, it is very useful to view the table in Storybook."})}),"\n",(0,s.jsxs)(n.p,{children:["The definition of the tablecolumns can be taken from the\n",(0,s.jsx)(n.a,{href:"https://tanstack.com/table/v8/docs/guide/column-defs",children:"Tanstack Table Documentation"}),".\nA simple example shall be discussed here nonetheless. The following code snippet\nhas been adapted from ",(0,s.jsx)(n.code,{children:"PageDIDMetadata"}),", with custom styles and most custom\ncomponents removed for clarity."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'// imports and type definitions\nimport { createColumnHelper } from "@tanstack/react-table"\ntype DIDKeyValuePairViewModel = {\n // from DIDKeyValuePair entity\n key: string;\n value: string;\n\n // from BaseViewModel\n status: \'success\' | \'error\' | \'pending\';\n message?: string;\n}\n\n// the streamedtable receives a stream of `DIDKeyValuePairViewModel`\n// each element is converted into a row\n// initialise the columnHelper to this type\nconst columnHelper = createColumnHelper()\n\n\n// define the tablecolumns array\nconst tablecolumns: any[] = [\n // Accessor columns have an underlying data model which means they can be\n // sorted, filtered, grouped, etc.\n columnHelper.accessor("key", { // this column accesses the "key" attribute\n id: "key",\n // function to render each body cell of the column, return JSX object\n // "info" contains the value but also other useful context -> read docs\n cell: info => {\n return (\n \n {info.getValue()}\n \n )\n },\n // funxtion to render header cell of column, return JSX object\n // "info": context useful for the creation of a header cell -> read docs\n header: info => {\n return (\n // this is a custom component that can be placed into the header\n // they are discussed further below\n \n )\n }\n }\n ),\n columnHelper.accessor("value", { // column accesses the "value" attribute\n id: "value",\n cell: info => {\n return (\n {info.getValue()}\n )\n },\n header: info => {\n return (\n // must not use a custom component, a simple

    tag is fine!\n

    Value

    \n )\n }\n })\n]\n'})}),"\n",(0,s.jsx)(n.p,{children:"Passing this column definition into a StreamedTable together with the ComDOM supplying the data like so"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"\n tablecomdom={comdom}\n tablecolumns={tablecolumns}\n/>\n"})}),"\n",(0,s.jsx)(n.p,{children:"will return a fully functional StreamedTable. This can be expanded upon to\ncreate much complex tables with multiple columns."}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsx)(n.p,{children:"The StreamedTable is a wrapper for Tanstack Table. In particular, the column\ndefinitions have been taken over unchanged. This means that the documentation\nand examples provided by Tanstack are also valid in the StreamedTables, check\nthem out."})}),"\n",(0,s.jsx)(n.h3,{id:"common-components-for-column-headers",children:"Common components for column headers"}),"\n",(0,s.jsxs)(n.p,{children:["A number of reusable components have been added to the StreamedTable package\nwhich can be used to implement frequently-needed functionality such as sorting\nand filtering. An example of this has already been given in the code above, in\nwhich a ",(0,s.jsx)(n.code,{children:"TableFilterString"})," component used."]}),"\n",(0,s.jsxs)(n.p,{children:["These components are added in the column header definitions within the\n",(0,s.jsx)(n.code,{children:"tablecolumns"})," definition, i.e."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'columnHelper.accessor("foo", {\n header: info => ,\n ...\n})\n'})}),"\n",(0,s.jsx)(n.p,{children:"The remainder of this section will introduce each of the common table\ncomponents."}),"\n",(0,s.jsx)(n.h4,{id:"tablesortupdown",children:"TableSortUpDown"}),"\n",(0,s.jsx)(n.p,{children:"This component toggles the Tanstack Table sorting mechanism on mouseclick and\ncycles between no sorting, sorting in ascending order and sorting in descending\norder. Examples of column entries which can be sorted are numeric data and\ndates."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableSortUpDown Dirty",src:t(12603).A+"",width:"154",height:"400"})," ",(0,s.jsx)(n.img,{alt:"TableFilterBoolean Clean",src:t(37624).A+"",width:"161",height:"401"})]}),"\n",(0,s.jsx)(n.p,{children:"It takes the following props:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'props: JSX.IntrinsicElements["div"] & {\n name: string\n column: Column\n element?: JSX.Element\n stack?: boolean\n nocollapse?: boolean\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"name"})," is the string which will be used as the column header with a default\nstyle if no ",(0,s.jsx)(n.code,{children:"element"})," is defined"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"column"})," is the table column the header belongs to."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"element"})," is the JSX element which overrides ",(0,s.jsx)(n.code,{children:"name"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"stack"})," determines whether the icon signifying the sorting state and the name\nelement are stacked vertically instead of horizontally. The example picture\nabove uses vertical stacking."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"nocollapse"})," will force the ",(0,s.jsx)(n.code,{children:"name"})," (or ",(0,s.jsx)(n.code,{children:"element"}),") to remain visible even on\nsmall screen widths (below 768px)."]}),"\n",(0,s.jsxs)(n.li,{children:["any props valid for a ",(0,s.jsx)(n.code,{children:"div"})," element will also work."]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterdiscrete",children:"TableFilterDiscrete"}),"\n",(0,s.jsx)(n.p,{children:"On mouseclick, it cycles through a list of keys and only displays the rows in\nwhich the column entry matches the key. Used when the column data is restricted\nto a small number of options, such as the Rucio enums."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableFilterDiscrete Dirty",src:t(52959).A+"",width:"236",height:"371"})," ",(0,s.jsx)(n.img,{alt:"TableFilterDiscrete Clean",src:t(52004).A+"",width:"232",height:"364"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type TableFilterDiscrete = JSX.IntrinsicElements["div"] & {\n name: string, // see TableSortUpDown\n keys: T[],\n renderFunc: (key: T | undefined) => JSX.Element,\n column: Column, // see TableSortUpDown\n stack?: boolean // see TableSortUpDown\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"keys"})," is a list of type ",(0,s.jsx)(n.code,{children:"T"})," where ",(0,s.jsx)(n.code,{children:"T"})," is the tyoe of the column entries.\nUsually a string enum."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"renderFunc"})," is the function used to render the icon to the side or below the\ntext (depending on whether ",(0,s.jsx)(n.code,{children:"state"})," is set)."]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterboolean",children:"TableFilterBoolean"}),"\n",(0,s.jsxs)(n.p,{children:["A special form of ",(0,s.jsx)(n.code,{children:"TableFilterDiscrete"})," in which the values are booleans. This\nmeans that no ",(0,s.jsx)(n.code,{children:"renderFunc"})," needs to be supplied."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"TableFilterBoolean in Action",src:t(18479).A+"",width:"430",height:"185"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'// see TableFilterDiscrete\ntype TableFilterBoolean = JSX.IntrinsicElements["div"] & {\n name: string,\n column: Column,\n stack?: boolean\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterstring",children:"TableFilterString"}),"\n",(0,s.jsx)(n.p,{children:"A filter in which the column entries are strings."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableFilterString Dirty",src:t(86965).A+"",width:"828",height:"370"})," ",(0,s.jsx)(n.img,{alt:"TableFilterString Clean",src:t(22174).A+"",width:"825",height:"114"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type TableFilterString = JSX.IntrinsicElements["form"] & {\n column: Column, // see TableFilterDiscrete\n name: string, // see TableFilterDiscrete\n placeholder?: string,\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"placeholder"})," is the placeholder string for the textbox"]}),"\n",(0,s.jsxs)(n.li,{children:["this component is not derived from ",(0,s.jsx)(n.code,{children:"div"})," but from ",(0,s.jsx)(n.code,{children:"form"}),". Any attributes valid\nin ",(0,s.jsx)(n.code,{children:"form"})," are also valid here."]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"These common StreamedTable components are very helpful in reducing the\ncomplexity of the column definitions you write. They also ensure a common design\nlanguage throughout the project. We encourage you to use them as much as\npossible."})}),"\n",(0,s.jsx)(n.h3,{id:"common-components-for-column-cells",children:"Common components for column cells"}),"\n",(0,s.jsx)(n.p,{children:"The selection here is quite limited right now, but shall be extended in order to\nkeep a common design language. It is also much easier to keep the project\naccessible if the total number of unique components is kept low."}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"TableInternalLink"})," for links within the rucio webui"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"TableExternalLink"})," for links pointing outside of the rucio webui."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"tablestyling",children:"TableStyling"}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsxs)(n.p,{children:["As with the rest of the Rucio WebUI, the StreamedTable is styled via ",(0,s.jsx)(n.a,{href:"https://tailwindcss.com/",children:"Tailwind\nCSS"}),". This means that styles are constructed by\nassigning various classes to an element. Tailwind will then compile a minimal\nset of CSS."]})}),"\n",(0,s.jsx)(n.p,{children:"This optional StreamedTable attribute itself only contains optional members. It\nis used to add to or override table styling settings."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"type TableStyling = Partial<{\n visibility?: Record\n tableHeadRowStyle?: string\n tableBodyRowStyle?: string\n pageSize?: number\n tableFooterStack?: boolean\n}>\n"})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"visibility"})," maps a column's visibility (boolean) to the column id (string)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableHeadRowStyle"}),": the classes which shall get passed to the ",(0,s.jsx)(n.code,{children:"tr"})," in the\n",(0,s.jsx)(n.code,{children:"thead"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableBodyRowStyle"}),": the classes which shall get passed to each ",(0,s.jsx)(n.code,{children:"tr"})," in the\n",(0,s.jsx)(n.code,{children:"tbody"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pageSize"})," is how many rows are shown per page at maximum."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableFooterStack"})," will stack table footer components in order to save\nhorizontal space."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"setting-column-widths",children:"Setting column widths"}),"\n",(0,s.jsx)(n.p,{children:"Column widths are set automatically, but they can be styled individually. This\nis done by adding a string of class names to the column definition in the\nfollowing way:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'columnHelper.accessor("foo", {\n meta: {\n style: "w-28 md:w-56" // see tailwind documentation for an explanation\n },\n ...\n})\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The Tailwind compiler has been configured to consider these styles as well when\nputting together the minimal set of CSS. Internally, the styles defined here are\napplied to the header cell. Since the StreamedTable ",(0,s.jsx)(n.code,{children:"table"})," element uses\n",(0,s.jsx)(n.code,{children:"table-layout: fixed"}),", the column widths of the first row will be applied to\neach of the following rows as well."]}),"\n",(0,s.jsx)(n.h3,{id:"tableselecting",children:"TableSelecting"}),"\n",(0,s.jsx)(n.p,{children:'This optional table attribute handles selecting rows and the "breakout". The\nbreakout is an infopanel placed under the table which shows columns for a single\nselected row (these columns would otherwise be hidden due to lack of horizontal\nspace), see the image below for an example.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"type TableSelecting = { // where T is the type of the table rows\n handleChange: (data: T[]) => void,\n enableRowSelection: boolean,\n enableMultiRowSelection?: boolean,\n breakOut?: {\n breakoutVisibility: boolean,\n keys: Record, // column id, displayname\n }\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"handleChange"})," is the function which is run each time the selection state\nchanges."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableRowSelection"}),": whether to enable row selection"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableMultiRowSelection"}),": whether to allow row multi-select (only valid if\nrow selection is enabled)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"breakout.breakoutVisibility"}),": whether to allow showing the breakout when a\nrow is selected. Often coupled to the horizontal window size."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"breakout.keys"}),": matching column id to the name under which it is to be\ndisplayed. The column ids determine which columns are going to be added to the\nbreakout. Usually, these columns end up being the columns that were hidden due\nto lack of horizontal space."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Table Breakout",src:t(45955).A+"",width:"889",height:"588"})}),"\n",(0,s.jsx)(n.h3,{id:"normaltable",children:"NormalTable"}),"\n",(0,s.jsxs)(n.p,{children:["The StreamedTable design is part of the design language of the Rucio WebUI, and\nwe intend for all tables (even if they are non-streaming) to follow this design.\nIt follows that we created the ",(0,s.jsx)(n.code,{children:"NormalTable"}),", which keeps the same design as the\nStreamedTable but without the streaming capabilities."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type NormalTableProps = JSX.IntrinsicElements["table"] & {\n tablecolumns: any[] // see StreamedTable\n tablestyling?: TableStyling // see StreamedTable\n tableselecting?: TableSelecting // see StreamedTable\n tabledata: T[]\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tabledata"}),": instead of passing a comdom which wraps the streamed data, we pas\nthe data directly in the form of an array."]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"streamedtable-in-the-context-of-nextjs",children:"StreamedTable in the context of NextJS"}),"\n",(0,s.jsx)(n.p,{children:"The StreamedTable relies on streams, which are rapped in the ComDOM. Until now,\nwe have taken the existence of a functioning ComDOM as given. In this section,\nwe will discuss how to properly embed the StreamedTable in the wider context of\nthe NextJS web application."}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsxs)(n.p,{children:["The frontend uses the NextJS app router. ",(0,s.jsx)(n.a,{href:"https://nextjs.org/docs",children:"Look at their\ndocs"})," to learn more."]})}),"\n",(0,s.jsx)(n.h4,{id:"queryclientprovider",children:"QueryClientProvider"}),"\n",(0,s.jsx)(n.p,{children:"On a layout-file affecting the route containing the StreamedTable, include the\nfollowing code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"'use client';\nimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'\n\nconst queryClient = new QueryClient();\n\nexport default function RootLayout({children}) {\n return (\n \n {children}\n \n )\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["where ",(0,s.jsx)(n.code,{children:"children"})," is a ",(0,s.jsx)(n.code,{children:"React.ReactNode"})," containing the StreamedTable."]}),"\n",(0,s.jsx)(n.h4,{id:"route",children:"Route"}),"\n",(0,s.jsxs)(n.p,{children:["On the route which returns the page including the StreamedTable, you must\ninitialise the ComDOM. You can optionally auto-start the ComDOM query or wait\nfor the user to trigger it manually -- this will not be covered in-depth here,\nsince this is more closely related to the ComDOM itself than to the\nStreamedTable. An example, taken and adapted from the ",(0,s.jsx)(n.code,{children:"ListSubscription"})," route,\nwould be:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'\'use client\';\nimport { ListSubscription as ListSubscriptionStory } from "@/component-library/Pages/Subscriptions/ListSubscription";\nimport { useEffect } from "react";\nimport useComDOM from "@/lib/infrastructure/hooks/useComDOM";\nimport { SubscriptionRuleStatesViewModel } from "@/lib/infrastructure/data/view-model/subscriptions";\n\nexport default function ListSubscription({ params }: { params: { account: string }}) {\n // initialise ComDOM\n const ComDOM = useComDOM(\n "subscription-rule-states-query",\n [],\n false,\n Infinity,\n 50,\n true\n )\n // auto-start query, GET data from /api/list-subscription, use param account\n useEffect(() => {\n const runQuery = async () => {\n await ComDOM.start({\n url: new URL("http://localhost:3000/api/list-subscription"),\n method: "GET",\n headers: new Headers({\n \'Content-Type\': \'application/json\'\n } as HeadersInit),\n params: {\n "account": params.account,\n }\n })\n }\n runQuery()\n }, [])\n // * return a react component\n // * in this case the StreamedTable is wrapped by a Storybook Page\n // * we pass the ComDOM to this page so that it may be passed further down\n // to the StreamedTable\n return (\n
    \n \n
    \n )\n}\n'})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},45955:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/breakout-bb5c25810ca88b4c2af415335d3d7d57.png"},18479:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-boolean-all-22de7b045ffd375da711fbeb0e3bfd63.png"},52004:(e,n,t)=>{t.d(n,{A:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOgAAAFsCAIAAABJnWJVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAIABJREFUeJzt3XdcFFe7B/CzheJSFukCKh0EwQ6IEBKxoDEGCxY0YIJG740lKu9NzKtBY3I1GqPXlly7MZYk+EZNuCioWBAMkpcqIE0sIL1KXXbn/jE4LMuyFMGds+f5fvLHZmZ2ZlgfDrNz5vwOh6IoBABuuMo+AQD6QvmF29TUxOFwOBzOyJEjlX0uLOXh4UF/ROXl5co+F7ZQfuF2paCggNPR0qVLlX1S/cPS0lL657KwsFD2GeFnQAr3/v37nC7Y2toOxBFf33fffSd9ngKBwM7OLjg4OCkpSdmnBuTgK/sEkLq6emRkJEJIR0dHerm5uXlmZiZCKCUlZdGiRW/4rBobG3Nzc3Nzcy9cuHD9+nVvb+9+3PmNGzdEIhFCaNSoUS0tLd1uv2/fvurqaoSQUCjsx9PA2sAWrouLy4IFC6SX6Ovry2zD5XL9/Pw6v1dNTc3R0REhRP+bvTGLFy+eNm1aeXn5yZMnMzIyWlpavvrqq+jo6H48hI2NDf2Cw+H0ZHsPD49+PLqKoAZAfHw8vfOFCxcq2MzBwUH6TJydnRXvbcmSJXI3EIvFR44c8fDw0NHR0dTUdHBwCA0NLS8v79U57969mz7K3r176SU5OTn0EgMDA+ktb968+e677xoYGKipqZmbmy9ZsiQ9PZ1ZS//1QAitW7cuPDzcyclJQ0PD0dHx+PHjnQ+qoaGBEDI3N5d7SitXrpT5xyorK5O75ZkzZ3x8fPT09DQ1Ne3s7FauXJmWlsaszcjI+Mc//jF27FgTExM+ny8UCj08PA4fPiyRSHr1EbEK9oUrkUhkGnXasGHDnj9/3vNz7ly4NTU19BITExNmswMHDnRuJjU1NaOiougNmMJ1c3OT2fLkyZMyB339wpVIJEuWLOn844eEhDDbhIWFdd4AIRQaGtrzz4dtBvZSIT09fevWrdJLAgMD7e3t6deRkZHNzc0tLS2jRo3q8yGOHz/+66+/IoSmTJny+eefa2lpXb58eefOnU+fPl27du3Fixf7ttvy8vIdO3bQrydOnEi/yMzMXL9+PUVR1tbWO3futLS0TEpKCg0NraurW7ZsWX5+Pl2ItISEBF9f32XLll2+fDk8PBwh9MUXXwQFBXG5Pf1CvG3btk8//RQhtGjRopSUFLnbHDly5OzZswghNTW11atXu7u7v3z5kv5AGFwud+bMmYsWLRo/fryenl5WVlZwcPCzZ88OHjwYFhamra3du4/m9VDi1sbitMK7x8vT4l4WPRfVNyCE1LQE2mYWhi6e5t4hg0xdOLwelOVA/DYwbWRnf/zxh8zGjY2N9Kq+tbhjx45FCAkEgpcvXzILvby8EEJ8Pl96oWJMiyvDysoqOzub3mbDhg30wpiYGOaNmzdvphdevXqVkmpxDQwMGhsbKYoSi8X0xTpCKDExUfqgiltchru7O/32zi2ui4sLvers2bPSywsLC5nXTU1NzGuxWCwSiTZu3Ei/Ky4uroefz+uTSMTN1YVph+ZGBRmkH5xccnNlw6MwcdEucdGuhkdhJTdXph+cHBVkkHZobnN1oUQiVrw35d9VeB0ikSg5ORkh1NDQ0LnlaG1tzc/PZ/5p+8Df3//cuXODBg2i/zchIYF+8c4773TeODs7e/r06cz/+vr6ampqIoS4XO6MGTOysrLobcaNG9fn85HR1NSUnp6OENLT0wsMDJReZWZmxryurKzcvXv3tWvX8vPzm5qapDcrKyvrr5NRjBKLytMu514I07Oy8PpitYaulvRaDR0tDUcbQ0cb6yneBbfi/94x1W7xVwYjZ3N4al3tcGA7IDpf486aNasf919bWyuRSBRs0NDQ0Nt9Ll68+MCBA5aWlgihS5cunTt3jlml+P6GzLEMDAyY14aGhvSL+vr63p6PAjU1NRRFIYTMzc272qaiomLChAl79+7NyMiQqVqEUE9uxr0+ipKUp13OPBE6dNJYh9lTZKpWmoaulsPsKUMnjc04vrE87TJFdfmPi0GLy1wUdq5RHR0dDodDUZSZmdlff/3V+b3Gxsa9PZybm9vq1aunTZvm6ura3Ny8ZcuWxYsXCwQChJCuri69zb1794YNGybzRpmbrNKNGfNaS6vDvxn9oyn+3VOAOZ/CwsKutvnpp5/otZaWlqdOnRo9erSuru6GDRv27dvXt4P2gai2OPdCmPVUb7Pxrj3Znt4s90KY0MpTXWgmdxv2dvkymI6Jzv886urqzs7OCKEXL15UV1dbdFRaWqqurt63g9rb2y9fvpze84EDB+iF9PU0Qig5OVnmWOXl5TLXKjdu3KDbV7FY/Oeff9IL7ezsOv9o5eXlzc3NfTjJQYMG0Q94VFdX//LLL9KrSkpK6BfPnj2jXwQGBvr4+AiFQg6Hk5iY2IfD9Q0lbs0+u0bPyqKHVUszG++qZ2WRfXYNJW6Vu4HSWtzi4mL6Ly/z16qlpYW+EEQIDRkyhGnAbGxsNDU1m5qaYmNjjx496unpyePxdHR06L+PK1asWLduHUVR06dP37Bhg4uLi1gsTk1NPX/+vLa2dmxsbJ/P8LPPPjty5IhIJNq1a9eqVauEQmFISAh9+3Pjxo2PHz/29vYWCAR5eXmXL1++evVqS0sLn9/+eVZVVU2bNu2DDz74448/cnNz6R9qzJgx0ocYOXLkzZs3RSJRaGhoSEiIpqYmj8eji7u2traoqIjejPkTn5ubSz9nIxQKhwwZghBatWrV6tWrEUJBQUEPHjxwc3Orq6u7cuWKsbHx0aNHEUJDhw6l3xsdHb1+/XotLa3Dhw+/zsfSW43FaS/+uu31xWoF2xSV1B46ce9WXF5lVeMQU90VS9wWzxlj+fbE2P8+aP1+msB8jJz3DMT3x57cxw0JCVHwk8jc8lyxYoXMBu+//z69SiwWz5kzR+5OJk2a1PNz7nwfl6IoutFFCG3evJlesmfPnq66u0QiESV1V8Hd3Z3H40lvcOrUKZmD0neypAmFQnrVmTNnFHw+wcHBzI8/f/78zhsw93FLSkqMjIzohRwOh744Ya65f/vtt55/RH2Tff6T9IOT6bsHcv+7cvpDHW0N6ZP/5ENPelX6wcnZ5z+Ru1sMLhUQQvv371+/fr2FhUXnm6BcLvfixYunT5/29fXV19fn8/lGRkajR49eu3btt99++5rH3bRpE92I7tu3j75O3bBhw+3btwMCAszNzdXU1IRCoaOjY2Bg4Pnz56WbW4SQh4dHeHi4g4ODurq6k5PT6dOng4ODZfYfGBj4ww8/jBgxQk2ty6/PinG53F9//fXEiRNeXl66urqampo2NjbLli1bu3YtvYGxsXFCQsLSpUuHDh2qpqbm4OCwf//+jz/+uG+H64PytDgjJ7uu1v7176cBK87UvWz2m+wYeW75zfCV7/s5v+3Z1iVu5GRXnhYn940cCkZA9KurV6/OmDEDIbRu3bo3+QWItaI/NPba9J8aOnLuJEgk1Jgpe9Ozin297a6eX87lchBCFEU1t4g1NfgIoea6+tgdh6eeLO38XjxaXIAvUX2D3KpFCEVcz0zPKuZwOId2zqGrFiHE4XDoqkUIaeho0V1rnUHhgoFFdX2z79y/khBCE8cNs7My7O3boXCB0tyMzUUITfWx78N7MeiAwIufnx98bZDG6eKhosLimvLKeoTQCDtFnURdvR1aXDCw1LQEzXVyOrorq9oermoVd3kt0VxXr6YlkLtKNQuXoqhjx455enrq6uoKBAJ7e/u5c+f+/PPPnR9doMctytzJ6oP+2o/q0TazqCss7rxcf3Dbo0s/X0xqEYkRQokpzy9cSpbepq6wWNtM/khS1fygg4ODpW/g5+Tk5OTk/P7776amplOmTFHiiRHI0MWzLCPT0NFGZrm5qXD8KIvElOdXb2bpO3w5SFOtsrrh4vEg6W3KMnIMXTzl7lYFW9y4uDi6avX09MLCwk6fPr17924/Pz+ZfizwZph7hxQlpDTXyrla+Plw4JiR5gihxiZRZXWDo63xWxOtmbXNtfVFCSnm3vJ7WFWwcO/fv0+/+Prrr7du3RoUFBQaGhoZGZmVlcUMjp8/fz49DP3JkycIIbFYzAxMl26So6OjQ0JCnJyc9PX11dTUTExMZs6cKT1wsof7QQjFxMTMmjXL0NBQXV3dwsJi6dKlDx8+HOBPghUGmboMcfcpuCVnbIGdlWFi1Lrc+5/f/781jx988fBOqL5e+xVtwa34Ie4+g0zlP06tgoXLPE2WkpIi/QXf1taWfsq257755psTJ05kZmZWVVW1traWlpZGRkZOnz6dedqrhw4ePOjr6xsREVFRUSESiQoLC8+ePTt+/Pj+HTzMThwe337JgerHz4sSU+VuYDVMf8LoocPM9aQXFiWmVj9+br/kQFfDeFSwy/fJkyeOjo70E1UjR45cvnz5ggUL6GepGEVFRbW1tQghX1/foqIiHo9HDyVACGlpaTFPVM2cOdPMzMzf39/Z2VlNTe3GjRsrVqwQiUReXl53797t4X4yMzNdXV1bW1s7j1QzMzOTGammkihKUp7yr8wToT18JLcoMTU/+u6Ij74zHDWXw+mibR3oh4OUIjw8XDrAgcfjLVy48NGjR523HD58OL2B3P1Ij9ZqbW0ViUTjx49HCGloaMiM7Vawn56MVFN5ktaW0qTf4j5zyvhxWkNWWFdPijVkhWX8OC3uM6ey5HBJa4uCHapgi0urqak5duzYqVOnmCZQKBRGRUW5ublJb2ZpafnkyRMej9faKueB5b///vv777+/d+9eYWGhzAY1NTXMAATF+/H29lbw/Ov+/fvXrFnT258ORxQlEdUWZ59d8+Kv22Zuo4yc7HTMTenHGJrr6usKi8sycooSUoa4+9gvOaCma9plW/tqdyouNTV15syZ9A/r7u4us1ZBS3n79m0FAyhkBtwq2I/iFMqdO3f24w/LfpJWUf3zf2ef/yTuizFRy4wiArQiArSilhnFfTEm+/wn9c//LWkV9WQ/ql+4FEU1NTXRQxe5XK70X39KYcHNnj2bri0/P7/U1FR6pPvo0aN7W7ienm13Iu/du/esk9ra2n79WUmhgncVIiIioqKipJdQFCUWixFCEomETptj0H1dEomE3kAaM1qLHhGkpaVVW1vL5DLJULCfXo1UAz2kgj1nOTk569evHzly5HvvvWdnZ9fc3PzTTz/R49ucnZ1lCsXExCQvL4+iqF27ds2ePZvH4zF3A4YOHUpnjF68eNHHx6e2tnb16tVdjS9XsJ9ejVQDPaXkFn8AdDXuQE1N7dq1azIbMzlLDF9fX3rV9evXmZFCdK8bj8cbPHgwvUTmUkHBfqgejFQDvaWChdvU1BQeHj5v3jx7e3uBQKChoWFtbR0cHEz3R8hoaWn58ssvR4wYwcTVSBfcnTt3pkyZYmhoOGjQoEmTJkVFRU2aNElu4SreD70ruSPVBuhDUHkqezsMqDYV/HIGSACFC7AEhQuwBIULsASFC7AEhQuwxG9o6M+oYQAGgkAgm4UDLS7AEhQuwFKHxzvqc2MeX9pRlpaMoDsNsAGHY+Qy2sp/k8BVduoQTn39S/pVfW5MwvaFzvPfHeY9HvVsqk4ABhZFPb2b+DA8wmv7JaHjVOk17YWb/t00YwfzYW9NUMYJAtClp3celGUXTdjSYfhT+zVuWVryMO/xb/ysAOjGMO/xpalJMgulvpxRFFwhADbicDp/6YK7CgBLULjK9CivrKqmUdlngSUoXIQQuh2f/8Hq86Mmfz92yt6P1v+a/6TyDRw0r6DCyXv3vYTHb+BYqof0wqUo6tMtV6YuOIIQ+mjxBB9Pmz+jMp48exOFW1rxcsHsUV7uVm/gWKqH9PGlYbujjpy5H/3LCp9Xc2t9vmayUFfzDRx64rjhE8cNfwMHUklEF25q5oudB2K2fzadqVqEkIlR+/j1v1Off733RnxigVhMTfa2PbRjjqF+29Mecz487TPR+vHTyvA/UxFCKz/w+HJj2x3yzTuvFpXUnti7gNlPbELBl7uuHdoxZ4Sd8dPC6mVrL9DLA+eOWb7EXfqUFq866zlheHOz+NjZv2rqmua/57r/6/eZEcJXb2Z99f31rNxSR1vjsI1T9x29u/er2Y62vZ5oWwUQfamw+9AtbS31NSFectf+3/VMr/cOaWrwf9w1b8Oqty7+mRa6rS1dNLeg4sq1h9v2RKur8374dq7bmGHb9kTfjsuj19a9bL4Umc7sRyQS/8d/XTQ10qFn6eDxOCGBbtPfcbgdn29s2CHkobi07tcrKfuO3C2rfPnNphmjR5odPhmXltWWQ3/hUvJ7QSfHjbI49T8LbSwNFq06e+te3nCLwf3+sWCB3Ba3sUl0KTJ93ixXwSA505FWVjcsW/fL4rlj6IbTfwa6fjeH+SJF12jYxqmffuyNEBrranHl2sOE5Gd0y21rZVBT21RV0zhYOAghtPvwreLSuhvhK+n3mpsKl8wbe+qXRC6X4+1hLX3QW3F5CKFNayfTzbCOtkbUrez6hhaE0JPnVav+6+Lm9VPCNk5FCPl62+nabvZ2txqk2ce5VHFHbosb96CgoVHk62Urd+2xswnVtU07/zmTWaIt0FBXa/s9vxWXN8REd01IW8YCPRMiMx8iPd3c46eVCKG8gopv9t3Ys/U9mcb1Vlye64ghdGVLLzQ3FX60uC1P8kVJLbO3H0/H83ncz9e8Q6/i8bhcLkf6Coc05BZuasYLhJCL0xC5ay9Fpr810Vq62rJySpwdTejXd+Lz/Wc483htn15GdglCyHVE265srY0QQk+eVSGEPtn0+yQ3q6AF42T2fyc+v3PZ3Y7LnzVtBDM5aGxCgYONEX1Vff735FnTnDTU2343Hj4qlkiotydaI1KRW7iV1Y0IIZk2j9baKklKKxwz0oxZkpFdkltQ8a7vCIRQbkHF8xc1Y13MmbVXrmWYGGlPcmu7sWVpMZjP5z5+Wnn+96R7CY9/3DVPZv+Pn1Y+eV71tmeHsisurcvOL3tbqppvx+fRxV1S9vJZUfUoqd+xy1cfqqvxPMaTe1OC3MI11BcghPILKjqvqqtvbhGJNTXaLx93HogxNtQOmD0KvbrAZS4uyyrqT/+S+NFiNz6/7cPk87mWFoOT0gs3bv1ja+g06+H6Mvu/HZ/f1QWuz8S2wi0srskrqKCLu6GxBaH27vryyvofT8e7jRlK7AUuIrlw353qxOdzQ7f9mZjyvLC45lrMo4AVZ5qaWxFCerqaBoMF4X+k5hVUlJS93Lzz6vnfk37cNY/+GncrLo/D4fz0299lFfUZ2SVzPzxlPkR38/oOc+zYWhud+1eSmYmQ/vZGq6hqKHhWVfCs6lrMI1tLw5rapoJnVUyX7624PEdbY+Zm3K177XU81EzPYLDgf3+Kvx2ff/1OzryPTldUNZB8gYtIvqtga2lw/PsFa/55yX3GfoSQhjp/+RI3+gsWh8PZt/39FRt/s/f8FiE0zFwv/FjQ+37O9BvvxOcHLRh3Jz7f1GUbQsjH0ybiyFLmmxnNZrg+l8v5Yddc5joYIbRo5c/0tMtt27jvQAj98O3cjz/woHf79qT2WrwVl+9gY2RqrIMQ4vO5R/cEfBwaPnnejy4jTP9zmWdsQsGUt+wG6qPBQfuD5DFBRjMObFPu2bx5Tc2tWbmlPC7Xeri+lqBDcH5tXdOjvDJtLQ1HWyOmCyC3oMLB89t/nQj2m+yQnlVsMFjLcqjsndSX9S2u7+yZPd153/bZ/XiqFEU1t4g1Nfhbvr12/veknPjPuoouVT2Ra8LeDe8wnS25LS5NU4M/2tlM7ipdHc0Jo4fKLLwdl8fhcLw9rDTU+eNc5Uwz29zSunzjbzwe55tNfv11kpk5pRZDhDraGpoa/L/+/XTfkTtH9wSQU7VykV64vXUrLs91hKn0BIgMiqJG++4teFZpMFjrz58/kmm/X8c/d0TeuJszysmsRSROy3yx7R/TF/mP7q+dY0qqcOnnzMn+Pe7Wh4smaGvJn0+vuUX85YapekLNSW5WMpe8r+nQjjn3/35aXFqnJ9R8Z5ItfeFLEHllCYMlAdt1M1jSyn/Tw/CIp3ceQKgCYAuKenrnwcPwCPuAMJk17S0ugkAQwDavAkGMFASCAMBaEHoHVAQULsASTBcFsAQtLsASFC7AUocOnpqs6OzftpWmJsHtMMAKHI6x6xj7gDCZjFEkfY1bkxUdu8Uf8nEBiyjIx2UK98F2LyN7M+jyBWzTTZdvaWoS5OMCFoJ8XIAnyMcFKgMKV5kgH7fPoHARgnxcDJFeuJCPiynSx5xBPi6miC5cyMfFF9GXCpCPiy9yW1zIx8UauS0u5ONijdzChXxcrJFbuJCPizVyCxfycbFGbuFCPi7WyL2rAPm4WGt/kDxivgDycaVXQT4ue0A+rizIx8UU6YXbW5CPyxKQj9s7kI+rBHLzcWGwJGC5bgZL2geEQT4uYBcF+bjS2WEQCALYpSeBIABghNyeM4A1KFyAJX5DQ72yzwGAbkCUPlARULgASx06eGC6KMAur6aLEiiYLqo+NyZh+0LIxwUsoiAfF6ZEBSzXTZdvWVoy5OMCFoJ8XIAnyMcFKgMKV5kgH7fPoHARgnxcDJFeuJCPiynSx5xBPi6miC5cyMfFF9GXCpCPiy9yW1zIx8UauS0u5ONijdzChXxcrJFbuJCPizVyCxfycbFGbuFCPi7WyL2rAPm4WGt/kDwmyAjycaVXQT4ue0A+rizIx8UU6YXbW5CPyxKQj9s7kI+rBHLzcWGwJGC5bgZLWvlvgnxcwC4K8nGZFhdBIAhgm1eBIEYKAkEAYC0IvQMqAgoXYAmi9AGWoMUFWILCBVjq0MED00UBdunJdFE1WdGxW/whHxewiIJ8XJgSFbBcN12+palJkI8LWAjycQGeIB8XqAwoXGWCfNw+g8JFCPJxMUR64UI+LqZIH3MG+biYIrpwIR8XX0RfKkA+Lr7IbXEhHxdr5La4kI+LNXILF/JxsUZu4UI+LtbILVzIx8UauYUL+bhYI/euAuTjYq39QfKI+QLIx5VeBfm47AH5uLIgHxdTpBdub0E+LktAPm7vQD6uEsjNx4XBkoDluhksaR8QBvm4gF0U5ONKZ4dBIAhgl54EggCAEXJ7zgDWoHABlvgNDfXKPgcAugFR+kBFQOECLHXo4IHpogC7vJouSqBguqj63JiE7QshHxewiIJ8XJgSFbBcN12+ZWnJkI8LWAjycQGeIB8XqAwoXGWCfNw+g8JFCPJxMUR64UI+LqZIH3MG+biYIrpwIR8XX0RfKkA+Lr7IbXEhHxdr5La4kI+LNXILF/JxsUZu4UI+LtbILVzIx8UauYUL+bhYI/euAuTjYq39QfKYICPIx5VeBfm47AH5uLIgHxdTpBdub0E+LktAPm7vQD6uEsjNx4XBkoDluhksaeW/CfJxAbsoyMdlWlwEgSCAbV4FghgpCAQBgLUg9A6oCChcgCWI0gdYghYXYAkKF2CpQwcPTBcF2KUn00XVZEXHbvGHfFzAIgrycWFKVMBy3XT5lqYmQT4uYCHIxwV4gnxcoDKgcJUJ8nH7DAoXIcjHxRDphQv5uJgifcwZ5ONiiujChXxcfBF9qQD5uPgit8WFfFyskdviQj4u1sgtXMjHxRq5hQv5uFgjt3AhHxdr5BYu5ONijdy7CpCPi7X2B8kj5gsgH1d6FeTjsgfk48qCfFxMkV64vQX5uCwB+bi9A/m4SiA3HxcGSwKW62awpH1AGOTjAnZRkI8rnR0GgSCAXXoSCAIARsjtOQNYg8IFWOI3NNQr+xwA6AZE6QMVAYULsNShgwemiwLs8mq6KIGC6aLqc2MSti+EfFzAIgrycWFKVMBy3XT5lqUlQz4uYCHIxwV4gnxcoDKgcJUJ8nH7DAoXIcjHxRDphQv5uJgifcwZ5ONiiujChXxcfBF9qQD5uPgit8WFfFyskdviQj4u1sgtXMjHxRq5hQv5uFgjt3AhHxdr5BYu5ONijdy7CpCPi7X2B8ljgowgH1d6FeTjsgfk48qCfFxMkV64vQX5uCwB+bi9A/m4SiA3HxcGSwKW62awpJX/JsjHBeyiIB+XaXERBIIAtnkVCGKkIBAEANaC0DugIqBwAZYgSh9gCVpcgCUoXIClDh08MF0UYJeeTBdVkxUdu8Uf8nEBiyjIx4UpUQHLddPlW5qaBPm4gIUgHxfgCfJxgcqAwlUmyMftMyhchCAfF0OkFy7k42KK9DFnkI+LKaILF/Jx8UX0pQLk4+KL3BYX8nGxRm6LC/m4WCO3cCEfF2vkFi7k42KN3MKFfFyskVu4kI+LNXLvKkA+LtbaHySPmC+AfFzpVZCPyx6QjysL8nExRXrh9hbk47IE5OP2DuTjKoHcfFwYLAlYrpvBkvYBYZCPC9hFQT6udHYYBIIAdulJIAgAGCG35wxgDQoXYInf0FCv7HMAoBsQpQ9UBBQuwFKHDh6YLgqwy6vpogQKpouqz41J2L4Q8nEBiyjIx4UpUQHLddPlW5aWDPm4gIUgHxfgCfJxgcqAwlUmyMftMyhchCAfF0OkFy7k42KK9DFnkI+LKaILF/Jx8UX0pQLk4+KL3BYX8nGxRm6LC/m4WCO3cCEfF2vkFi7k42KN3MKFfFyskVu4kI+LNXLvKkA+LtbaHySPCTKCfFzpVZCPyx6QjysL8nExRXrh9hbk47IE5OP2DuTjKoHcfFwYLAlYrpvBklb+myAfF7CLgnxcpsVFEAgC2OZVIIiRgkAQAFgLQu+AioDCBViCKH2AJWhxAZagcAGWOnTwwHRRgF16Ml1UTVZ07BZ/yMcFLKIgHxemRAUs102Xb2lqEuTjAhaCfFyAJ8jHBSoDCleZIB+3z6BwEYJ8XAyRXriQj4sp0secQT4upoguXMjHxRfRlwqQj4svcltcyMfFGrktLuTjYo3cwoV8XKyRW7iQj4s1cgsX8nEeodZyAAAAZUlEQVSxRm7hQj4u1si9qwD5uFhrf5A8Yr4A8nGlV0E+LntAPq4syMfFFOmF21uQj8sSkI/bO5CPqwRy83FhsCRguW4GS9oHhEE+LmAXBfm40tlhEAgC2KUngSAAYITcnjOAtf8Hr28uglRR5qoAAAAASUVORK5CYII="},52959:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-discrete-dirty-0910e099615f469d47dede0b1ab14040.png"},22174:(e,n,t)=>{t.d(n,{A:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzkAAAByCAIAAAD/B4h8AAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAGvNJREFUeJzt3XdUVNfaP/DnzABSHAaHoQhIEyRSRBHEKwbwh154sQSiGAULoqg3sRAr91qiaAwYMFkWjCUK+iIXIygqb0QwxBgsIYqJqAELtolSpCjNi8N5/9ivk/khAhoMI34/i5V1Zu9znrP35A+/a58yHM/zBAAAAAAqSdDZAwAAAACAF0JWAwAAAFBdyGoAAAAAqgtZDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUl1pnD+A1qm/kk8/VbD/5qKmzRwIAAADQJgHRTC/die7dtdQ5RSPXVX+3oL6RH7b+9yYijqMuOkUAAADoUlhoERDlLDFRxLUuu66WfK6micjfsVuYG6cmQFgDAAAAVfe0iduVx/9PwZPkczVhQ0Wsscuuqw3+VMZz9E2opqmRnlAo7OzhAAAAALRBLpfLSqqCEho4ns4uM2WNXXZdrYmIeFIT8AhqAAAA8EYQCoVqAp7nSXkhDc+BAgAAAKguZDUAAAAA1YWsBgAAAKC6kNUAAAAAVBeyGgAAAIDqQlYDAAAAUF3IagAAAACqC1kNAAAAQHUhq3VxHMe1vRMAAACoqpazmo2NDcdxHMc1NDSwlpqaGicnJ9a4e/fuv3CEAAAAAG+vdq2r8Tw/efLkgoICIlq0aNG0adNe86i6goaGBhZts7OzO3ssAAAA8KZq1++Brlq16tChQ0Q0cuTImJiY1zwkaM2GDRsePXo0ZswYFxeXzh4LAAAAvHZtr6ulpaWtWbOGiBwcHJKTkwWCPw5pamrasWPH3/72N11dXS0trXfeeWfx4sUPHz5kvadPn2YLS97e3soFAwICWHtGRkZHTkXFCIXCsWPHjh071sjIqAPLbtiwYfXq1RcuXOjAmgAAAKCy2lhXu3Tp0tSpU3mel0qlR44cEYlEii6e5ydOnLh//35FS2FhYWFh4f79+0+fPm1qajpkyBB7e/srV6788MMP9+7dMzMzI6JHjx4dO3aMiHr27Onn5/d6JqUS1NXVDxw40NmjAAAAgDdbG+tqY8eOrampIaLPP//cyspKuevrr79mQW348OHZ2dlnzpyJjIwkojt37sybN4/tM2PGDCLieT45OZm1HDp06MmTJ0Q0adIkoVDYwbN5edu2bevXr5+Ojo5YLHZ2do6NjVV0paen+/r6mpiYaGhoSCQSf3//X375hXXNmTOH47hRo0ZFRkZKJBKxWPzhhx82Njay3uzsbE5Js/vV5HJ5dHR0nz59NDQ0DA0NQ0JCbt++zbq++uorjuMsLS3Xr19vZGQklUoXL17M8zwR3bp1i1WTyWREFB4ezj7u3LmTHfvw4cPZs2ez0VpZWS1durS+vv41f3kAAADw+vEt6d27d7PdvLy8mu3D7pfS1tauqalRNA4dOpSI1NTUWGN5ebmGhgYROTs7sx38/f1ZwcuXL7d46o7itvae29p7svtlreyTlJREROrq6r6+vr6+vsbGxsrTDAkJEQqFdnZ2vr6+vXr1IiJjY+P6+nqe5z/66CMi0tTUlEqlXl5e7L0Yq1evZgfm5eV5eHgMGTKEzTQrK0v5pOzJDA0NDRcXFwMDAyIyNTUtLy/neX7r1q2sy9TU1NPTkx1+9OhRnufv37/v4eHh4eHBvk8bGxv28ciRIzzP19bWOjo6EpGenp6Li4u2tjYR+fn58Tz/ov/FAAAAoIJk98tYhlG0tJ3VxGIx20hLS1Ps8J///Ef5xrXn/frrr2zPDz74QBHOKioq1NXVicjd3f21zpNvX1Zjy35hYWHsY2Nj49mzZxW9hw8flslkbLumpoZ9Dyx4sawmFAqvXbvG8/zSpUuJyMjISLm4YllLOav9+uuvLMv+8ssvbB9nZ2ciWrduHf8sq3Ecx8oOHDiQiJYsWaJc1tTUlIh27Nih3Lhp0yYW4Kqrq3mev3nzpqamJhGdPn0aWQ0AAOAN8nxWa+N+tZCQkNDQ0BEjRrDQMGrUKBa2Hj161NTU1MqBdXV1bGPGjBkpKSlElJSUZG1tzS4UhoaGtn7ev4atrS0RJSQklJSU+Pv7jxkzxt3dXdHr6en573//++LFi9XV1U1NTXK5nIju3r2r2MHFxcXGxoaIgoKCYmJiSkpKysvLpVJpK2c8ceIEEamrqy9ZsoS1sEcx8vLyFPsYGRmxstbW1ufPny8rK2tzIuwya319/fjx41kLS9LKZQEAAOBN1EZWi4+P19XV9fPzO3bs2PXr17ds2RIREUFEIpGI4zie501MTM6dO/f8gYaGhmzDx8fH2tr65s2bycnJbLlOU1NzwoQJHT2RVzF37tyrV68mJSVlZGRkZGTMmTNnyZIl0dHRRFRZWenu7n7t2rVmh7Cb7ZgePXo022gzq7FkVl9fn5mZqdz++PFjxXa3bt3YBstbrWdi5bIymYzdzdZiWQAAAHgTtfFsAbs7av369Sw3REVFVVRUsHYHBwciun//flVVldn/r7S0lB1IRBzHhYWFEVFxcTFb/gkICNDT03udk2ovLS2t3bt3l5WVpaensyuhMTEx7DJlWloaC2p79+5lFxZ79uzZ7PA7d+6wDcViG7v/rBUs1Zmbmzdb8MzKyvozE2Flp0yZ0qzssmXL/kxZAAAA6HTt+t0CJycndtWysrIyKiqKNYaHhxMRz/O+vr5xcXHHjx//9ttvY2Ji+vfvr3gOlJk2bZryI5+q87MH586du337tlgsHjNmzM6dO9kDBCx4VVVVEZGmpuakSZN0dXVv3Ljx4MGDZof/9ttv6enpjY2NX3zxBREZGRnp6+u3fkb2qrk7d+4ont+sr6/fs2fPd999184xa2lpEVFJScnzZQ8ePKh471ppaemaNWtKS0vbWRYAAABUVIv3tSmeLWCPPfI8L5PJ2NOF6urqRUVFPM/L5fLAwMAWa3p4eDQrOHr0aNZlZmYml8tf9X67l9CeZwuWLVsmEAicnJxGjRrl5ORERDo6Ovfv3+d5Pj8/n+XL8PDwzZs3v/POO2z8W7du5Z89W8CSGbuBj4iioqJY2XHjxik/B+ro6Mie2SwtLeV5Pjg4mLVLpVILCwu2YLl3717+2bMFFhYWrA57LIO9304hKCiIiNTU1Nzc3BTPgT569MjOzo6IOI7r1auX4u27LHd29FcLAAAAr8vzzxa0a12NiExMTBYsWEBEjY2NixcvJiKBQJCampqYmOjj4yORSNTU1AwMDNii2vO/Q8USBhFNmTKl9QdI/0re3t7+/v6VlZVZWVkymczb2zsjI8PY2JiI+vfvn5KS0q9fv6SkpI0bN86YMaPZ6+WIaPDgwXFxcSKRSE9Pb86cOez1ckSUl5eXm5vLnsEkooKCgtzc3NzcXHav2549e2JjY52cnGpqasrLy62tradPnz548OB2jjkmJsbPz09HR+fnn3/Ozc1lq30ikSg3N3fu3Lnm5uYPHjx48uSJs7Pz0qVLJRJJh3xRAAAA0Fk4nuf/gtNMnTp1z549RFRUVMSevnzdBn0qI6JD07uZGLd2s/+rmTNnzpYtW0aOHHn06NEOL96x2CMgnT0KAAAAaJffH5QHfP2EiH5aZspa2vXb7a9MJpM9fvz4hx9+YG+d/fvf//7XBDUAAACAruH1ZrUPPvggNzeXbaurq7PfgAcAAACAdvorbh0TCoUODg4HDx4cNGjQX3C6v8DmzZt5nlf9C6AAAADwpnu962o//vjja63fCgERz9HTJk4ul6vCj8R3FtysBgAA8KaQy+VPmziOI07pX+/Xm9U60Uwv3a9OPtqVx4e5VakJkFcAAABA1T1t4nbl8TxPs7x0FY1d9iHB+kZ+2Prfm4g4jrroFAEAAKBLYaFFQJSzxERLnfu/xq6a1YiovpFPPlez/eSjtn9QEwAAAKCzCYhmeulOdO+uCGrUtbMaAAAAwJtOVX5CAAAAAACeh6wGAAAAoLqQ1QAAAABUF7IaAAAAgOpCVgMAAABQXc3fhVtXV9sp4wAAAACA52FdDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUF7IaAAAAgOpCVgMAAABQXchqAAAAAKoLWQ0AAABAdSGrERH5+fl98MGEjq2Znn54165dHVsTAAAA3jbIakREFhaW5ua9OrZmenr6rl27O7YmAAAAvG2a/x7o22nbtq86ewgAAAAALWhhXa2yslJPr8fGjZuUGwcP/tuECRMVHzMyMjw9vfT1pb16mUdERNTX1yvv3KuX+YoVK3fs2Onk5CSR6Ds5OV28eJF15eTkeHl56+tLzcx6hYVNLysra+dA7969O2XKFEtLK319qZOT08qVnyi6cnJy3n9/rLV17x49JA4OjlFRaxobG1nX06dPdXS6R0ZGjh49Rl9famNjGxsbq1xWR6c7+2vxGuiLpvnTTz/p6HRPTk4eOXKUVGrg4OC4f/9+xVESib6OTveUlJT8/HxF/erqatbb1NS0YcMGZ2dnNtr4+K3t/AYAAADgLdTCulqPHj18fHzS0tLmzZvLWq5fv3Hp0qVFixaxjykpKdOnzxg3buyKFcsfPHiwcuUn9fUNzZamMjIydHV1v/zyS2Nj49zc00+fPiWi/Pz8gIBAT0/PpKT/LisrW758RWDg+z/8cFIgaPtS7NSpodXV1Zs2bZRI9IuKCs+cOavounSpwNHRcerUqRKJ5Pr1a598sqqurjY6OlqxQ3z81ri4uMTEhBMnvps5c6aRkdHkyZNZ15Url1nx58/Y5jTXrFm7efOmvn37fvrpulmzZr/77rs9e/YkoosX83meX7o08ubNm998838ZTiQSsY158+bv3bt34cKF77479Ny5c//617/EYt2QkJA2vwEAAAB4C3E8zyt/rqurJaKUlJSwsOlXr14xNzcnopiYmLi4DbduFWtra8vlclvbPnZ2dt9++z/skEOH0idPnnzp0q+WlpaspVcv86ampsLC37p3765cPCxsemZm5vXr17S0tIjo4MFDkyZNOnw43cfHp/VRyuVyPb0ea9eumT9/fptTio6O3rx5y717d4no6dOnYrHesGHDjh49wnqnT59x4cKF/PwLyof4+fmJxXopKf9WPmMr0/zpp5+GDft/n322bt68eURUUlJibd179+5d48ePV55sUVHRjz+eUj7R1atXXV3dli9f9s9//pO1LFy48NixzMuXC9qcFwAAALyFWl7QGjlylJaW1sGDB9nHAwdSR47019bWJqIrV66UlJQEB/9xPdTT892mpqZLly4pVxgxYnizoEZEFy6c9/DwYEGN7UNEP//8s2KH2tra6mcU1zGJSCgU2tvbb9u2PSEh4bfffmtqalIuW11dvWLFSldXN2PjnhKJ/mefRVdWVrKVPMbNzU2x7erqWlRU1NDQ0Pr30p5p9uvXj20YGRkJBIIHDx60XpOIvvsuh4gmTvyj7Lvvet66dUtxhRQAAABAWctZrXt3nf/6L7/U1DQiKioqunLlSlBQEOt6+PAhEc2dO08i0Wd/Nja2RCST/a5cwcTE9Pmy1dWPJBKJ0lm6q6urV1X9EVOCg0NMTEzZX2pqqvKx33yzf+jQoVFRawYOdLW27q38OoyQkEn79u2LiJh//Hjm2bNnIiIiiEg5q+nqihTbYrEuEZWWlrb+vbRnmiy8MhzHKYfL1su6uAxUlA0NDSUimUzW5rEAAADwFnrhc6DjxgUFBwffvn37wIEDYrF4+PDhrJ2FrS+//GLIkCHK+xsaGip/FAqFz9cUi3UrKioUH2tqahobG/X0xIqW6OjPKiuXsu0+fWyVjzU3N9++fRsRFRYWrlz5yfz5EcOGDbOysiotLc3JydmxY3twcDDbUzmlMeXlD5ttS6XSF038pab5siQSCcdxJ09+361bN+V2CwuLP1MWAAAAuqoXZjVf37+LRKK0tLTU1LSAgAANDQ3Wbm9vb2BgcPnyZbYg9FJcXAYeO3asrq6OrUhlZh4nIldXV8UOffv2bbOInZ3dwoULjh49+vvv962srGpra4lIX1+f9fI8f+zYsWaHnDhx4tNP1yq2bW1tlJfEWvRnpsmIxbo1NTXNGocN8+Z5vri4eMyYMa9WFgAAAN4qL8xqmpqao0eP3rx5y4MHD2JjP//jADW1des+nTVrdn19g5+fr7q6emFh4cGDh5KS/tvExKT1k3300YcHDhwYNy7oo48+LC0tXbnyE2dnZ29v7zZHWVFRERj4/oQJE955x66uri42Ns7Q0NDZ2ZmILCwsbG1tN23a7OLiQkTr1q27d+9es8Nv3Lgxc+assWPfz8nJyc7Ojo/foij7+PFjImpoeKKuXnf79m0iEovFenp6f2aajJOT044dOxMSEtzd3YVCoY2NjUAgcHBwmDx58syZsy5fvuzm5lZbW3fx4sXz588fPpzenpoAAADwtmntXbjjxwft27fP0NDQ09NTuT04OFhPT2/Dhg0pKSkCgaB3795+fn49evRo82QDBw5MS0uNilozefIUTU1NX1/fmJjoFq+WNqOlpeXg4LBt21d3797T0dEZNGjQpk0bu3fXISKBQLB/f8rHHy9wcHDU0tIKCAhYunTJihUrlQ+PiIgoKCgICZkkFotXrfpk6tSprH358hWJiYmK3eztHYhowYIFa9ZE/ZlpMpMmTbpwIX/16qiysjKe53//XSYWi4koPn6LvX3fhITE9es/F4lE9vb2Eyd28M9bAQAAQJfR8js7ugz2zo6YmJg5cz7q7LEAAAAAvDT8HigAAACA6kJWAwAAAFBdXfwaKAAAAMAbDetqAAAAAKoLWQ0AAABAdSGrAQAAAKguZDUAAAAA1YWsBgAAAKC6kNUAAAAAVFfzd3YAAAAAgOrAuhoAAACA6kJWAwAAAFBdyGoAAAAAqgtZDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUF7IaAAAAgOrqnKzm7e0dEBDQsTU3bNhw/Pjxjq35mlRUVKxataqoqKizBwIAAACqrnOympWVlYWFRcfWfLOy2urVq5HVAAAAoE1qnXLW3bt3d8p5AQAAAN4sL1xXO3XqlKenp56enkgkGjBgQHJysqIrOzt75MiRPXv27Natm7W19YoVKxobGxVdHMd9+eWXTk5O3bp1c3BwyMjIUC7LPfP8NdCmpqaYmJg+ffqwshs3blR0nT17luO4vXv3Dh8+XFtb29raet++fcpdHMfJZLK4uDi23b9///aUbV0r0zQzMwsNDbW0tLS0tDx8+LCDg4NUKk1ISFAcW1BQMHr0aLFYrKOjM2rUqOLiYtYeHR3NcZytrS0RjR49mo02IiKinUMCAACAtw7fkrKyMpFI9N5772VlZWVlZUVHR69bt07RGxcXFxkZmZqa+v3332/fvl0qlX788cesKysri4gMDAxOnDhRWloaGRmprq5eWFioOLa4uLi4uNjd3f29995rdtLw8HA1NbXly5dnZWVFRUWpq6snJCSwrjNnzhCRpaXl8ePHZTJZeHi4hoaGTCbjeb6hoYHVNDY2Dg8PZ9usq82yrWtlmqampoMGDcrKyrKwsNDQ0Pjmm2/CwsKMjIxY79WrV1nAPXDgwKFDh9zc3GxtbRsbG3mer6qqKi4u/v7774no66+/ZqN9+PBhe8YDAAAAb6GWs1pOTg4R5eXltadEVFSURCJh2yyrrV27ln2Uy+Xm5uazZ89udoiXl1ezrFZQUEBEq1evVrTMmTPHysqKbbOsFhsbyz7ev3+fiJKSkpQrmJqaLly4sNmJWi/7UpSnaWpqGh0dzfP89OnTHR0deZ5n8auyspLn+XHjxunr6ysSmEwm09DQSExMVJS6du0aER05cuQVhgEAAABvlZavgdrZ2Wlqai5atCg1NfXu3bvNequqqiIjIx0dHcVisaamZlRUVEVFxdOnTxU7uLu7sw2BQODq6pqfn9/m8l52djYRTZ48WdHi7e1dXFxcVVWlaFFc2TQ2NhYIBCyx/cmycrm86pnHjx+3f5q6urrsv2xDJBIRUU1NDT27eCqRSNieJiYmffr0uXDhQpujBQAAAGim5azWs2fPzMxMbW3t0NBQc3Nze3t7trLFBAUF7dmzZ9GiRSdPnrx48eLixYuJSDmrsfjCiMXikpKSNsdRXl5ORH379tV8ZuLEiUR07949xT46OjqKbY7jFHeP/ZmyeXl5PZ4ZMGCA8rGtT5PjOCISCASKDdbLwl9SUpKmksuXLytPBAAAAKCdXvgcqKenp6enp1wu//HHH//xj38EBwezG+RLSkqys7MTExOnTJnC9lROaQxLSIptQ0PDNsehr6/Pcdy5c+e6deum3G5lZdX+ybxCWQcHh1OnTrFtLS0txQ7tmWaLhEKhWCweP378ggULlNvZwhsAAADAS2njnR1CodDLy2vKlCkrV66Uy+VCobC2tpaIpFIp24Hn+WZPehJRZmamv78/ETU0NJw6dWr8+PFtjsPHx4fn+Zs3bwYGBr7KPIjEYjG7BPlSZUUi0dChQ59vb880X8THx+f8+fO2trZCofBFQ6VnF0wBAAAAWtFyVktPT09ISAgMDDQ3N799+/bGjRtHjBjBkoelpaWdnd0XX3zh6upKRKtXr37+hraEhAQjI6N+/frFx8fX1NR8/PHHrP3hw4fsnrCGhoa6urpbt24RkVgs7tGjh5OT07Rp00JDQy9duuTu7l5bW3vhwoW8vLzMzMx2zsTZ2Tk9PT0gIMDS0lJTU9PS0pKIXrlse6b5ImvWrHF3dx8xYkR4eLhUKr1161ZGRkZISEhQUBDbwcDAwMTEJD4+3tLSUk9PTyKRtGfpEQAAAN5GLT5xcOXKlffff9/MzExDQ8PMzGzWrFnl5eWK3qtXr/r4+Ojo6BgYGMyePTs6OpqI6uvr+WfPgSYmJrq6umpoaPTt2/fw4cOKA6dPn/78AJYuXcp65XJ5bGxs3759NTQ0pFKpt7f3zp07WRe7W+7MmTOKUkKh8LPPPlMec3Fxsa+vr56eHhE5Ozsr2lsp27pWpmlqarp161ae5xcuXOjh4cHzPHt+ori4mB1bUFAQGBgokUg0NTVtbW1nz55948YN5eLZ2dkDBgxgV13nz5/fnvEAAADAW4jjeb4Dk192dvaIESPy8/OV30YLAAAAAK+mc34PFAAAAADaA1kNAAAAQHV18DVQAAAAAOhAWFcDAAAAUF3IagAAAACqC1kNAAAAQHUhqwEAAACoLmQ1AAAAANX1vxX3UZBynRtLAAAAAElFTkSuQmCC"},86965:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-string-dirty-dadee973219a779404cf2c4443cc5ee3.png"},37624:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/sort-updown-clean-18a717b9686dfecb04d47a3f794daf68.png"},12603:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/sort-updown-dirty-2148a91f5adf2a2c0272b096834b8c98.png"},2119:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/streamedtable-4cf5d169c74626898e013335a0a4d34a.png"},28453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>o});var i=t(96540);const s={},a=i.createContext(s);function l(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f6323a9.da3215b7.js b/assets/js/1f6323a9.da3215b7.js deleted file mode 100644 index 3091491090..0000000000 --- a/assets/js/1f6323a9.da3215b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6068],{34369:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"developer/webui/streamedtables","title":"Using the WebUI StreamedTable Component","description":"Data presentation in the WebUI","source":"@site/../docs/developer/webui/streamedtables.md","sourceDirName":"developer/webui","slug":"/developer/webui/streamedtables","permalink":"/documentation/developer/webui/streamedtables","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/webui/streamedtables.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"streamedtables","title":"Using the WebUI StreamedTable Component"},"sidebar":"docs","previous":{"title":"Setting up a WebUI Developer Environment using Visual Studio Code","permalink":"/documentation/developer/webui/webui_frontend_vscode_dev_env"},"next":{"title":"Developing the WebUI Frontend","permalink":"/documentation/developer/webui/webui_frontend"}}');var s=t(74848),a=t(28453);const l={id:"streamedtables",title:"Using the WebUI StreamedTable Component"},o=void 0,r={},c=[{value:"Data presentation in the WebUI",id:"data-presentation-in-the-webui",level:2},{value:"StreamedTable",id:"streamedtable",level:2},{value:"TableColumns",id:"tablecolumns",level:3},{value:"Common components for column headers",id:"common-components-for-column-headers",level:3},{value:"TableSortUpDown",id:"tablesortupdown",level:4},{value:"TableFilterDiscrete",id:"tablefilterdiscrete",level:4},{value:"TableFilterBoolean",id:"tablefilterboolean",level:4},{value:"TableFilterString",id:"tablefilterstring",level:4},{value:"Common components for column cells",id:"common-components-for-column-cells",level:3},{value:"TableStyling",id:"tablestyling",level:3},{value:"Setting column widths",id:"setting-column-widths",level:3},{value:"TableSelecting",id:"tableselecting",level:3},{value:"NormalTable",id:"normaltable",level:3},{value:"StreamedTable in the context of NextJS",id:"streamedtable-in-the-context-of-nextjs",level:2},{value:"QueryClientProvider",id:"queryclientprovider",level:4},{value:"Route",id:"route",level:4}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"data-presentation-in-the-webui",children:"Data presentation in the WebUI"}),"\n",(0,s.jsx)(n.p,{children:'An issue we encountered in the process of developing the WebUI which is\nparticularly relevant in the context of writing a Rucio frontend is streaming.\nThe "old" web frontend (which we want to replace) had the issue that it would\nfreeze on starting larger queries, with no indication as to the progress made or\npotential errors encountered. Even when everything worked well, these "freezes"\ncould last for up to several minutes in which the page was effectively unusable.'}),"\n",(0,s.jsx)(n.p,{children:"The reason for this was the fact that any responses from the Rucio server (which\nsupports streaming) were stored in a WebUI intermediary, before being forwarded\nto the client in one batch. Since Rucio responses can be huge (and often, there\nis no prior indication of the size which a query will take), this could lead to\nfreezing of unknown duration."}),"\n",(0,s.jsxs)(n.p,{children:["The solution would be to pass the stream from Rucio through the WebUI\nbackend/core to the frontend. This required special software engineering on the\nbackend, which shall not be covered here. The frontend accesses the streams via\na system called the ",(0,s.jsx)(n.code,{children:"ComDOM"}),", short for ",(0,s.jsx)(n.code,{children:"Communication Document Object Model"}),".\nIt accesses the streams provided by the backend API layer (and NOT the Rucio\nserver itself) and wraps the data with further tooling (to start/pause/stop the\nstream, inspect the state, etc.)."]}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["Streamed data is unavoidable in the WebUI. The UI accesses this data in the form\nof the ",(0,s.jsx)(n.code,{children:"ComDOM"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["The generic component when dealing with streamed data is the ",(0,s.jsx)(n.code,{children:"StreamedTable"}),",\nwhich is a custom HTML table framework based on ",(0,s.jsx)(n.a,{href:"https://tanstack.com/table/v8/docs/introduction",children:"Tanstack\nTable"})," and optimized for\nuse with the streams fed in via the ComDOM. A StreamedTable is defined by a set\nof react props passed into the component (which will be described below). The\nframework is completed by a plethora of ready-to-use components which solve the\nmajority of required usecases when it comes to streamed tables."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"StreamedTable Example",src:t(2119).A+"",width:"892",height:"456"})}),"\n",(0,s.jsx)(n.h2,{id:"streamedtable",children:"StreamedTable"}),"\n",(0,s.jsxs)(n.p,{children:["The StreamedTable is a fully typed react component based on the HTML ",(0,s.jsx)(n.code,{children:"table"})," element. The props it takes are defined in the codeblock below."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'type StreamedTableProps = JSX.IntrinsicElements["table"] & {\n tablecomdom: UseComDOM\n tablecolumns: any[]\n tablestyling?: TableStyling\n tableselecting?: TableSelecting\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The table expects a stream of elements of type ",(0,s.jsx)(n.code,{children:"T"}),", where ",(0,s.jsx)(n.code,{children:"T"})," extends the\n",(0,s.jsx)(n.code,{children:"BaseViewModel"}),". In practice, this means that an entity is wrapped in an object\nproviding status and an optional errormessage."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The data shown by the table is passed into the ",(0,s.jsx)(n.code,{children:"tablecomdom"})," prop as an\n",(0,s.jsx)(n.code,{children:"UseComDOM"})," object. This object also provides functions to inspect and control\nthe stream. The generic ",(0,s.jsx)(n.code,{children:"UseComDOM"})," type is bound to type ",(0,s.jsx)(n.code,{children:"T"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The table structure (i.e. the way data is structured into columns) is defined\nby the ",(0,s.jsx)(n.code,{children:"tablecolumns"})," prop. This is essentially an array of column definition\nobjects (which are taken from Tanstack Table), but there are exceptions, which\nmake typing this prop difficult. Most of your time building a streamedtable is\nspent writing this definition."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["The first optional prop, ",(0,s.jsx)(n.code,{children:"tablestyling"})," is a structure containing style\ncommands for the table. The definition of the ",(0,s.jsx)(n.code,{children:"TableStyling"})," type is given\nbelow."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"tableselecting"}),' optionally defines how the user can select (single- or\nmulti-select) elements from the table. It also controls the "breakout"\nfunctionality. This is discussed later.']}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:'JSX.IntrinsicElements["table"]'})," means that the StreamedTable component will\nreturn a react component with the HTML ",(0,s.jsx)(n.code,{children:"
    "})," tag as its top-level component,\nwhich in turn means that any valid HTML table-properties can be passed to the\nStreamedTable, and these will be passed on to the top-level component. This\nspecifically also includes styling the top-level ",(0,s.jsx)(n.code,{children:"
    "})," via ",(0,s.jsx)(n.code,{children:"className"})," but\nalso ARIA-properties."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"tablecolumns",children:"TableColumns"}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"When creating a new component or editing a new one, it is very useful to view the table in Storybook."})}),"\n",(0,s.jsxs)(n.p,{children:["The definition of the tablecolumns can be taken from the\n",(0,s.jsx)(n.a,{href:"https://tanstack.com/table/v8/docs/guide/column-defs",children:"Tanstack Table Documentation"}),".\nA simple example shall be discussed here nonetheless. The following code snippet\nhas been adapted from ",(0,s.jsx)(n.code,{children:"PageDIDMetadata"}),", with custom styles and most custom\ncomponents removed for clarity."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'// imports and type definitions\nimport { createColumnHelper } from "@tanstack/react-table"\ntype DIDKeyValuePairViewModel = {\n // from DIDKeyValuePair entity\n key: string;\n value: string;\n\n // from BaseViewModel\n status: \'success\' | \'error\' | \'pending\';\n message?: string;\n}\n\n// the streamedtable receives a stream of `DIDKeyValuePairViewModel`\n// each element is converted into a row\n// initialise the columnHelper to this type\nconst columnHelper = createColumnHelper()\n\n\n// define the tablecolumns array\nconst tablecolumns: any[] = [\n // Accessor columns have an underlying data model which means they can be\n // sorted, filtered, grouped, etc.\n columnHelper.accessor("key", { // this column accesses the "key" attribute\n id: "key",\n // function to render each body cell of the column, return JSX object\n // "info" contains the value but also other useful context -> read docs\n cell: info => {\n return (\n \n {info.getValue()}\n \n )\n },\n // funxtion to render header cell of column, return JSX object\n // "info": context useful for the creation of a header cell -> read docs\n header: info => {\n return (\n // this is a custom component that can be placed into the header\n // they are discussed further below\n \n )\n }\n }\n ),\n columnHelper.accessor("value", { // column accesses the "value" attribute\n id: "value",\n cell: info => {\n return (\n {info.getValue()}\n )\n },\n header: info => {\n return (\n // must not use a custom component, a simple

    tag is fine!\n

    Value

    \n )\n }\n })\n]\n'})}),"\n",(0,s.jsx)(n.p,{children:"Passing this column definition into a StreamedTable together with the ComDOM supplying the data like so"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"\n tablecomdom={comdom}\n tablecolumns={tablecolumns}\n/>\n"})}),"\n",(0,s.jsx)(n.p,{children:"will return a fully functional StreamedTable. This can be expanded upon to\ncreate much complex tables with multiple columns."}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsx)(n.p,{children:"The StreamedTable is a wrapper for Tanstack Table. In particular, the column\ndefinitions have been taken over unchanged. This means that the documentation\nand examples provided by Tanstack are also valid in the StreamedTables, check\nthem out."})}),"\n",(0,s.jsx)(n.h3,{id:"common-components-for-column-headers",children:"Common components for column headers"}),"\n",(0,s.jsxs)(n.p,{children:["A number of reusable components have been added to the StreamedTable package\nwhich can be used to implement frequently-needed functionality such as sorting\nand filtering. An example of this has already been given in the code above, in\nwhich a ",(0,s.jsx)(n.code,{children:"TableFilterString"})," component used."]}),"\n",(0,s.jsxs)(n.p,{children:["These components are added in the column header definitions within the\n",(0,s.jsx)(n.code,{children:"tablecolumns"})," definition, i.e."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'columnHelper.accessor("foo", {\n header: info => ,\n ...\n})\n'})}),"\n",(0,s.jsx)(n.p,{children:"The remainder of this section will introduce each of the common table\ncomponents."}),"\n",(0,s.jsx)(n.h4,{id:"tablesortupdown",children:"TableSortUpDown"}),"\n",(0,s.jsx)(n.p,{children:"This component toggles the Tanstack Table sorting mechanism on mouseclick and\ncycles between no sorting, sorting in ascending order and sorting in descending\norder. Examples of column entries which can be sorted are numeric data and\ndates."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableSortUpDown Dirty",src:t(12603).A+"",width:"154",height:"400"})," ",(0,s.jsx)(n.img,{alt:"TableFilterBoolean Clean",src:t(37624).A+"",width:"161",height:"401"})]}),"\n",(0,s.jsx)(n.p,{children:"It takes the following props:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'props: JSX.IntrinsicElements["div"] & {\n name: string\n column: Column\n element?: JSX.Element\n stack?: boolean\n nocollapse?: boolean\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"name"})," is the string which will be used as the column header with a default\nstyle if no ",(0,s.jsx)(n.code,{children:"element"})," is defined"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"column"})," is the table column the header belongs to."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"element"})," is the JSX element which overrides ",(0,s.jsx)(n.code,{children:"name"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"stack"})," determines whether the icon signifying the sorting state and the name\nelement are stacked vertically instead of horizontally. The example picture\nabove uses vertical stacking."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"nocollapse"})," will force the ",(0,s.jsx)(n.code,{children:"name"})," (or ",(0,s.jsx)(n.code,{children:"element"}),") to remain visible even on\nsmall screen widths (below 768px)."]}),"\n",(0,s.jsxs)(n.li,{children:["any props valid for a ",(0,s.jsx)(n.code,{children:"div"})," element will also work."]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterdiscrete",children:"TableFilterDiscrete"}),"\n",(0,s.jsx)(n.p,{children:"On mouseclick, it cycles through a list of keys and only displays the rows in\nwhich the column entry matches the key. Used when the column data is restricted\nto a small number of options, such as the Rucio enums."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableFilterDiscrete Dirty",src:t(52959).A+"",width:"236",height:"371"})," ",(0,s.jsx)(n.img,{alt:"TableFilterDiscrete Clean",src:t(52004).A+"",width:"232",height:"364"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type TableFilterDiscrete = JSX.IntrinsicElements["div"] & {\n name: string, // see TableSortUpDown\n keys: T[],\n renderFunc: (key: T | undefined) => JSX.Element,\n column: Column, // see TableSortUpDown\n stack?: boolean // see TableSortUpDown\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"keys"})," is a list of type ",(0,s.jsx)(n.code,{children:"T"})," where ",(0,s.jsx)(n.code,{children:"T"})," is the tyoe of the column entries.\nUsually a string enum."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"renderFunc"})," is the function used to render the icon to the side or below the\ntext (depending on whether ",(0,s.jsx)(n.code,{children:"state"})," is set)."]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterboolean",children:"TableFilterBoolean"}),"\n",(0,s.jsxs)(n.p,{children:["A special form of ",(0,s.jsx)(n.code,{children:"TableFilterDiscrete"})," in which the values are booleans. This\nmeans that no ",(0,s.jsx)(n.code,{children:"renderFunc"})," needs to be supplied."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"TableFilterBoolean in Action",src:t(18479).A+"",width:"430",height:"185"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'// see TableFilterDiscrete\ntype TableFilterBoolean = JSX.IntrinsicElements["div"] & {\n name: string,\n column: Column,\n stack?: boolean\n}\n'})}),"\n",(0,s.jsx)(n.h4,{id:"tablefilterstring",children:"TableFilterString"}),"\n",(0,s.jsx)(n.p,{children:"A filter in which the column entries are strings."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.img,{alt:"TableFilterString Dirty",src:t(86965).A+"",width:"828",height:"370"})," ",(0,s.jsx)(n.img,{alt:"TableFilterString Clean",src:t(22174).A+"",width:"825",height:"114"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type TableFilterString = JSX.IntrinsicElements["form"] & {\n column: Column, // see TableFilterDiscrete\n name: string, // see TableFilterDiscrete\n placeholder?: string,\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"placeholder"})," is the placeholder string for the textbox"]}),"\n",(0,s.jsxs)(n.li,{children:["this component is not derived from ",(0,s.jsx)(n.code,{children:"div"})," but from ",(0,s.jsx)(n.code,{children:"form"}),". Any attributes valid\nin ",(0,s.jsx)(n.code,{children:"form"})," are also valid here."]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"These common StreamedTable components are very helpful in reducing the\ncomplexity of the column definitions you write. They also ensure a common design\nlanguage throughout the project. We encourage you to use them as much as\npossible."})}),"\n",(0,s.jsx)(n.h3,{id:"common-components-for-column-cells",children:"Common components for column cells"}),"\n",(0,s.jsx)(n.p,{children:"The selection here is quite limited right now, but shall be extended in order to\nkeep a common design language. It is also much easier to keep the project\naccessible if the total number of unique components is kept low."}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"TableInternalLink"})," for links within the rucio webui"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"TableExternalLink"})," for links pointing outside of the rucio webui."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"tablestyling",children:"TableStyling"}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsxs)(n.p,{children:["As with the rest of the Rucio WebUI, the StreamedTable is styled via ",(0,s.jsx)(n.a,{href:"https://tailwindcss.com/",children:"Tailwind\nCSS"}),". This means that styles are constructed by\nassigning various classes to an element. Tailwind will then compile a minimal\nset of CSS."]})}),"\n",(0,s.jsx)(n.p,{children:"This optional StreamedTable attribute itself only contains optional members. It\nis used to add to or override table styling settings."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"type TableStyling = Partial<{\n visibility?: Record\n tableHeadRowStyle?: string\n tableBodyRowStyle?: string\n pageSize?: number\n tableFooterStack?: boolean\n}>\n"})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"visibility"})," maps a column's visibility (boolean) to the column id (string)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableHeadRowStyle"}),": the classes which shall get passed to the ",(0,s.jsx)(n.code,{children:"tr"})," in the\n",(0,s.jsx)(n.code,{children:"thead"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableBodyRowStyle"}),": the classes which shall get passed to each ",(0,s.jsx)(n.code,{children:"tr"})," in the\n",(0,s.jsx)(n.code,{children:"tbody"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pageSize"})," is how many rows are shown per page at maximum."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tableFooterStack"})," will stack table footer components in order to save\nhorizontal space."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"setting-column-widths",children:"Setting column widths"}),"\n",(0,s.jsx)(n.p,{children:"Column widths are set automatically, but they can be styled individually. This\nis done by adding a string of class names to the column definition in the\nfollowing way:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'columnHelper.accessor("foo", {\n meta: {\n style: "w-28 md:w-56" // see tailwind documentation for an explanation\n },\n ...\n})\n'})}),"\n",(0,s.jsxs)(n.p,{children:["The Tailwind compiler has been configured to consider these styles as well when\nputting together the minimal set of CSS. Internally, the styles defined here are\napplied to the header cell. Since the StreamedTable ",(0,s.jsx)(n.code,{children:"table"})," element uses\n",(0,s.jsx)(n.code,{children:"table-layout: fixed"}),", the column widths of the first row will be applied to\neach of the following rows as well."]}),"\n",(0,s.jsx)(n.h3,{id:"tableselecting",children:"TableSelecting"}),"\n",(0,s.jsx)(n.p,{children:'This optional table attribute handles selecting rows and the "breakout". The\nbreakout is an infopanel placed under the table which shows columns for a single\nselected row (these columns would otherwise be hidden due to lack of horizontal\nspace), see the image below for an example.'}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"type TableSelecting = { // where T is the type of the table rows\n handleChange: (data: T[]) => void,\n enableRowSelection: boolean,\n enableMultiRowSelection?: boolean,\n breakOut?: {\n breakoutVisibility: boolean,\n keys: Record, // column id, displayname\n }\n}\n"})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"handleChange"})," is the function which is run each time the selection state\nchanges."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableRowSelection"}),": whether to enable row selection"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"enableMultiRowSelection"}),": whether to allow row multi-select (only valid if\nrow selection is enabled)"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"breakout.breakoutVisibility"}),": whether to allow showing the breakout when a\nrow is selected. Often coupled to the horizontal window size."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"breakout.keys"}),": matching column id to the name under which it is to be\ndisplayed. The column ids determine which columns are going to be added to the\nbreakout. Usually, these columns end up being the columns that were hidden due\nto lack of horizontal space."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Table Breakout",src:t(45955).A+"",width:"889",height:"588"})}),"\n",(0,s.jsx)(n.h3,{id:"normaltable",children:"NormalTable"}),"\n",(0,s.jsxs)(n.p,{children:["The StreamedTable design is part of the design language of the Rucio WebUI, and\nwe intend for all tables (even if they are non-streaming) to follow this design.\nIt follows that we created the ",(0,s.jsx)(n.code,{children:"NormalTable"}),", which keeps the same design as the\nStreamedTable but without the streaming capabilities."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'type NormalTableProps = JSX.IntrinsicElements["table"] & {\n tablecolumns: any[] // see StreamedTable\n tablestyling?: TableStyling // see StreamedTable\n tableselecting?: TableSelecting // see StreamedTable\n tabledata: T[]\n}\n'})}),"\n",(0,s.jsx)(n.p,{children:"Explanation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"tabledata"}),": instead of passing a comdom which wraps the streamed data, we pas\nthe data directly in the form of an array."]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"streamedtable-in-the-context-of-nextjs",children:"StreamedTable in the context of NextJS"}),"\n",(0,s.jsx)(n.p,{children:"The StreamedTable relies on streams, which are rapped in the ComDOM. Until now,\nwe have taken the existence of a functioning ComDOM as given. In this section,\nwe will discuss how to properly embed the StreamedTable in the wider context of\nthe NextJS web application."}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsxs)(n.p,{children:["The frontend uses the NextJS app router. ",(0,s.jsx)(n.a,{href:"https://nextjs.org/docs",children:"Look at their\ndocs"})," to learn more."]})}),"\n",(0,s.jsx)(n.h4,{id:"queryclientprovider",children:"QueryClientProvider"}),"\n",(0,s.jsx)(n.p,{children:"On a layout-file affecting the route containing the StreamedTable, include the\nfollowing code:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:"'use client';\nimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'\n\nconst queryClient = new QueryClient();\n\nexport default function RootLayout({children}) {\n return (\n \n {children}\n \n )\n}\n"})}),"\n",(0,s.jsxs)(n.p,{children:["where ",(0,s.jsx)(n.code,{children:"children"})," is a ",(0,s.jsx)(n.code,{children:"React.ReactNode"})," containing the StreamedTable."]}),"\n",(0,s.jsx)(n.h4,{id:"route",children:"Route"}),"\n",(0,s.jsxs)(n.p,{children:["On the route which returns the page including the StreamedTable, you must\ninitialise the ComDOM. You can optionally auto-start the ComDOM query or wait\nfor the user to trigger it manually -- this will not be covered in-depth here,\nsince this is more closely related to the ComDOM itself than to the\nStreamedTable. An example, taken and adapted from the ",(0,s.jsx)(n.code,{children:"ListSubscription"})," route,\nwould be:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-tsx",children:'\'use client\';\nimport { ListSubscription as ListSubscriptionStory } from "@/component-library/Pages/Subscriptions/ListSubscription";\nimport { useEffect } from "react";\nimport useComDOM from "@/lib/infrastructure/hooks/useComDOM";\nimport { SubscriptionRuleStatesViewModel } from "@/lib/infrastructure/data/view-model/subscriptions";\n\nexport default function ListSubscription({ params }: { params: { account: string }}) {\n // initialise ComDOM\n const ComDOM = useComDOM(\n "subscription-rule-states-query",\n [],\n false,\n Infinity,\n 50,\n true\n )\n // auto-start query, GET data from /api/list-subscription, use param account\n useEffect(() => {\n const runQuery = async () => {\n await ComDOM.start({\n url: new URL("http://localhost:3000/api/list-subscription"),\n method: "GET",\n headers: new Headers({\n \'Content-Type\': \'application/json\'\n } as HeadersInit),\n params: {\n "account": params.account,\n }\n })\n }\n runQuery()\n }, [])\n // * return a react component\n // * in this case the StreamedTable is wrapped by a Storybook Page\n // * we pass the ComDOM to this page so that it may be passed further down\n // to the StreamedTable\n return (\n
    \n \n
    \n )\n}\n'})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},45955:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/breakout-bb5c25810ca88b4c2af415335d3d7d57.png"},18479:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-boolean-all-22de7b045ffd375da711fbeb0e3bfd63.png"},52004:(e,n,t)=>{t.d(n,{A:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOgAAAFsCAIAAABJnWJVAAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAIABJREFUeJzt3XdcFFe7B/CzheJSFukCKh0EwQ6IEBKxoDEGCxY0YIJG740lKu9NzKtBY3I1GqPXlly7MZYk+EZNuCioWBAMkpcqIE0sIL1KXXbn/jE4LMuyFMGds+f5fvLHZmZ2ZlgfDrNz5vwOh6IoBABuuMo+AQD6QvmF29TUxOFwOBzOyJEjlX0uLOXh4UF/ROXl5co+F7ZQfuF2paCggNPR0qVLlX1S/cPS0lL657KwsFD2GeFnQAr3/v37nC7Y2toOxBFf33fffSd9ngKBwM7OLjg4OCkpSdmnBuTgK/sEkLq6emRkJEJIR0dHerm5uXlmZiZCKCUlZdGiRW/4rBobG3Nzc3Nzcy9cuHD9+nVvb+9+3PmNGzdEIhFCaNSoUS0tLd1uv2/fvurqaoSQUCjsx9PA2sAWrouLy4IFC6SX6Ovry2zD5XL9/Pw6v1dNTc3R0REhRP+bvTGLFy+eNm1aeXn5yZMnMzIyWlpavvrqq+jo6H48hI2NDf2Cw+H0ZHsPD49+PLqKoAZAfHw8vfOFCxcq2MzBwUH6TJydnRXvbcmSJXI3EIvFR44c8fDw0NHR0dTUdHBwCA0NLS8v79U57969mz7K3r176SU5OTn0EgMDA+ktb968+e677xoYGKipqZmbmy9ZsiQ9PZ1ZS//1QAitW7cuPDzcyclJQ0PD0dHx+PHjnQ+qoaGBEDI3N5d7SitXrpT5xyorK5O75ZkzZ3x8fPT09DQ1Ne3s7FauXJmWlsaszcjI+Mc//jF27FgTExM+ny8UCj08PA4fPiyRSHr1EbEK9oUrkUhkGnXasGHDnj9/3vNz7ly4NTU19BITExNmswMHDnRuJjU1NaOiougNmMJ1c3OT2fLkyZMyB339wpVIJEuWLOn844eEhDDbhIWFdd4AIRQaGtrzz4dtBvZSIT09fevWrdJLAgMD7e3t6deRkZHNzc0tLS2jRo3q8yGOHz/+66+/IoSmTJny+eefa2lpXb58eefOnU+fPl27du3Fixf7ttvy8vIdO3bQrydOnEi/yMzMXL9+PUVR1tbWO3futLS0TEpKCg0NraurW7ZsWX5+Pl2ItISEBF9f32XLll2+fDk8PBwh9MUXXwQFBXG5Pf1CvG3btk8//RQhtGjRopSUFLnbHDly5OzZswghNTW11atXu7u7v3z5kv5AGFwud+bMmYsWLRo/fryenl5WVlZwcPCzZ88OHjwYFhamra3du4/m9VDi1sbitMK7x8vT4l4WPRfVNyCE1LQE2mYWhi6e5t4hg0xdOLwelOVA/DYwbWRnf/zxh8zGjY2N9Kq+tbhjx45FCAkEgpcvXzILvby8EEJ8Pl96oWJMiyvDysoqOzub3mbDhg30wpiYGOaNmzdvphdevXqVkmpxDQwMGhsbKYoSi8X0xTpCKDExUfqgiltchru7O/32zi2ui4sLvers2bPSywsLC5nXTU1NzGuxWCwSiTZu3Ei/Ky4uroefz+uTSMTN1YVph+ZGBRmkH5xccnNlw6MwcdEucdGuhkdhJTdXph+cHBVkkHZobnN1oUQiVrw35d9VeB0ikSg5ORkh1NDQ0LnlaG1tzc/PZ/5p+8Df3//cuXODBg2i/zchIYF+8c4773TeODs7e/r06cz/+vr6ampqIoS4XO6MGTOysrLobcaNG9fn85HR1NSUnp6OENLT0wsMDJReZWZmxryurKzcvXv3tWvX8vPzm5qapDcrKyvrr5NRjBKLytMu514I07Oy8PpitYaulvRaDR0tDUcbQ0cb6yneBbfi/94x1W7xVwYjZ3N4al3tcGA7IDpf486aNasf919bWyuRSBRs0NDQ0Nt9Ll68+MCBA5aWlgihS5cunTt3jlml+P6GzLEMDAyY14aGhvSL+vr63p6PAjU1NRRFIYTMzc272qaiomLChAl79+7NyMiQqVqEUE9uxr0+ipKUp13OPBE6dNJYh9lTZKpWmoaulsPsKUMnjc04vrE87TJFdfmPi0GLy1wUdq5RHR0dDodDUZSZmdlff/3V+b3Gxsa9PZybm9vq1aunTZvm6ura3Ny8ZcuWxYsXCwQChJCuri69zb1794YNGybzRpmbrNKNGfNaS6vDvxn9oyn+3VOAOZ/CwsKutvnpp5/otZaWlqdOnRo9erSuru6GDRv27dvXt4P2gai2OPdCmPVUb7Pxrj3Znt4s90KY0MpTXWgmdxv2dvkymI6Jzv886urqzs7OCKEXL15UV1dbdFRaWqqurt63g9rb2y9fvpze84EDB+iF9PU0Qig5OVnmWOXl5TLXKjdu3KDbV7FY/Oeff9IL7ezsOv9o5eXlzc3NfTjJQYMG0Q94VFdX//LLL9KrSkpK6BfPnj2jXwQGBvr4+AiFQg6Hk5iY2IfD9Q0lbs0+u0bPyqKHVUszG++qZ2WRfXYNJW6Vu4HSWtzi4mL6Ly/z16qlpYW+EEQIDRkyhGnAbGxsNDU1m5qaYmNjjx496unpyePxdHR06L+PK1asWLduHUVR06dP37Bhg4uLi1gsTk1NPX/+vLa2dmxsbJ/P8LPPPjty5IhIJNq1a9eqVauEQmFISAh9+3Pjxo2PHz/29vYWCAR5eXmXL1++evVqS0sLn9/+eVZVVU2bNu2DDz74448/cnNz6R9qzJgx0ocYOXLkzZs3RSJRaGhoSEiIpqYmj8eji7u2traoqIjejPkTn5ubSz9nIxQKhwwZghBatWrV6tWrEUJBQUEPHjxwc3Orq6u7cuWKsbHx0aNHEUJDhw6l3xsdHb1+/XotLa3Dhw+/zsfSW43FaS/+uu31xWoF2xSV1B46ce9WXF5lVeMQU90VS9wWzxlj+fbE2P8+aP1+msB8jJz3DMT3x57cxw0JCVHwk8jc8lyxYoXMBu+//z69SiwWz5kzR+5OJk2a1PNz7nwfl6IoutFFCG3evJlesmfPnq66u0QiESV1V8Hd3Z3H40lvcOrUKZmD0neypAmFQnrVmTNnFHw+wcHBzI8/f/78zhsw93FLSkqMjIzohRwOh744Ya65f/vtt55/RH2Tff6T9IOT6bsHcv+7cvpDHW0N6ZP/5ENPelX6wcnZ5z+Ru1sMLhUQQvv371+/fr2FhUXnm6BcLvfixYunT5/29fXV19fn8/lGRkajR49eu3btt99++5rH3bRpE92I7tu3j75O3bBhw+3btwMCAszNzdXU1IRCoaOjY2Bg4Pnz56WbW4SQh4dHeHi4g4ODurq6k5PT6dOng4ODZfYfGBj4ww8/jBgxQk2ty6/PinG53F9//fXEiRNeXl66urqampo2NjbLli1bu3YtvYGxsXFCQsLSpUuHDh2qpqbm4OCwf//+jz/+uG+H64PytDgjJ7uu1v7176cBK87UvWz2m+wYeW75zfCV7/s5v+3Z1iVu5GRXnhYn940cCkZA9KurV6/OmDEDIbRu3bo3+QWItaI/NPba9J8aOnLuJEgk1Jgpe9Ozin297a6eX87lchBCFEU1t4g1NfgIoea6+tgdh6eeLO38XjxaXIAvUX2D3KpFCEVcz0zPKuZwOId2zqGrFiHE4XDoqkUIaeho0V1rnUHhgoFFdX2z79y/khBCE8cNs7My7O3boXCB0tyMzUUITfWx78N7MeiAwIufnx98bZDG6eKhosLimvLKeoTQCDtFnURdvR1aXDCw1LQEzXVyOrorq9oermoVd3kt0VxXr6YlkLtKNQuXoqhjx455enrq6uoKBAJ7e/u5c+f+/PPPnR9doMctytzJ6oP+2o/q0TazqCss7rxcf3Dbo0s/X0xqEYkRQokpzy9cSpbepq6wWNtM/khS1fygg4ODpW/g5+Tk5OTk/P7776amplOmTFHiiRHI0MWzLCPT0NFGZrm5qXD8KIvElOdXb2bpO3w5SFOtsrrh4vEg6W3KMnIMXTzl7lYFW9y4uDi6avX09MLCwk6fPr17924/Pz+ZfizwZph7hxQlpDTXyrla+Plw4JiR5gihxiZRZXWDo63xWxOtmbXNtfVFCSnm3vJ7WFWwcO/fv0+/+Prrr7du3RoUFBQaGhoZGZmVlcUMjp8/fz49DP3JkycIIbFYzAxMl26So6OjQ0JCnJyc9PX11dTUTExMZs6cKT1wsof7QQjFxMTMmjXL0NBQXV3dwsJi6dKlDx8+HOBPghUGmboMcfcpuCVnbIGdlWFi1Lrc+5/f/781jx988fBOqL5e+xVtwa34Ie4+g0zlP06tgoXLPE2WkpIi/QXf1taWfsq257755psTJ05kZmZWVVW1traWlpZGRkZOnz6dedqrhw4ePOjr6xsREVFRUSESiQoLC8+ePTt+/Pj+HTzMThwe337JgerHz4sSU+VuYDVMf8LoocPM9aQXFiWmVj9+br/kQFfDeFSwy/fJkyeOjo70E1UjR45cvnz5ggUL6GepGEVFRbW1tQghX1/foqIiHo9HDyVACGlpaTFPVM2cOdPMzMzf39/Z2VlNTe3GjRsrVqwQiUReXl53797t4X4yMzNdXV1bW1s7j1QzMzOTGammkihKUp7yr8wToT18JLcoMTU/+u6Ij74zHDWXw+mibR3oh4OUIjw8XDrAgcfjLVy48NGjR523HD58OL2B3P1Ij9ZqbW0ViUTjx49HCGloaMiM7Vawn56MVFN5ktaW0qTf4j5zyvhxWkNWWFdPijVkhWX8OC3uM6ey5HBJa4uCHapgi0urqak5duzYqVOnmCZQKBRGRUW5ublJb2ZpafnkyRMej9faKueB5b///vv777+/d+9eYWGhzAY1NTXMAATF+/H29lbw/Ov+/fvXrFnT258ORxQlEdUWZ59d8+Kv22Zuo4yc7HTMTenHGJrr6usKi8sycooSUoa4+9gvOaCma9plW/tqdyouNTV15syZ9A/r7u4us1ZBS3n79m0FAyhkBtwq2I/iFMqdO3f24w/LfpJWUf3zf2ef/yTuizFRy4wiArQiArSilhnFfTEm+/wn9c//LWkV9WQ/ql+4FEU1NTXRQxe5XK70X39KYcHNnj2bri0/P7/U1FR6pPvo0aN7W7ienm13Iu/du/esk9ra2n79WUmhgncVIiIioqKipJdQFCUWixFCEomETptj0H1dEomE3kAaM1qLHhGkpaVVW1vL5DLJULCfXo1UAz2kgj1nOTk569evHzly5HvvvWdnZ9fc3PzTTz/R49ucnZ1lCsXExCQvL4+iqF27ds2ePZvH4zF3A4YOHUpnjF68eNHHx6e2tnb16tVdjS9XsJ9ejVQDPaXkFn8AdDXuQE1N7dq1azIbMzlLDF9fX3rV9evXmZFCdK8bj8cbPHgwvUTmUkHBfqgejFQDvaWChdvU1BQeHj5v3jx7e3uBQKChoWFtbR0cHEz3R8hoaWn58ssvR4wYwcTVSBfcnTt3pkyZYmhoOGjQoEmTJkVFRU2aNElu4SreD70ruSPVBuhDUHkqezsMqDYV/HIGSACFC7AEhQuwBIULsASFC7AEhQuwxG9o6M+oYQAGgkAgm4UDLS7AEhQuwFKHxzvqc2MeX9pRlpaMoDsNsAGHY+Qy2sp/k8BVduoQTn39S/pVfW5MwvaFzvPfHeY9HvVsqk4ABhZFPb2b+DA8wmv7JaHjVOk17YWb/t00YwfzYW9NUMYJAtClp3celGUXTdjSYfhT+zVuWVryMO/xb/ysAOjGMO/xpalJMgulvpxRFFwhADbicDp/6YK7CgBLULjK9CivrKqmUdlngSUoXIQQuh2f/8Hq86Mmfz92yt6P1v+a/6TyDRw0r6DCyXv3vYTHb+BYqof0wqUo6tMtV6YuOIIQ+mjxBB9Pmz+jMp48exOFW1rxcsHsUV7uVm/gWKqH9PGlYbujjpy5H/3LCp9Xc2t9vmayUFfzDRx64rjhE8cNfwMHUklEF25q5oudB2K2fzadqVqEkIlR+/j1v1Off733RnxigVhMTfa2PbRjjqF+29Mecz487TPR+vHTyvA/UxFCKz/w+HJj2x3yzTuvFpXUnti7gNlPbELBl7uuHdoxZ4Sd8dPC6mVrL9DLA+eOWb7EXfqUFq866zlheHOz+NjZv2rqmua/57r/6/eZEcJXb2Z99f31rNxSR1vjsI1T9x29u/er2Y62vZ5oWwUQfamw+9AtbS31NSFectf+3/VMr/cOaWrwf9w1b8Oqty7+mRa6rS1dNLeg4sq1h9v2RKur8374dq7bmGHb9kTfjsuj19a9bL4Umc7sRyQS/8d/XTQ10qFn6eDxOCGBbtPfcbgdn29s2CHkobi07tcrKfuO3C2rfPnNphmjR5odPhmXltWWQ3/hUvJ7QSfHjbI49T8LbSwNFq06e+te3nCLwf3+sWCB3Ba3sUl0KTJ93ixXwSA505FWVjcsW/fL4rlj6IbTfwa6fjeH+SJF12jYxqmffuyNEBrranHl2sOE5Gd0y21rZVBT21RV0zhYOAghtPvwreLSuhvhK+n3mpsKl8wbe+qXRC6X4+1hLX3QW3F5CKFNayfTzbCOtkbUrez6hhaE0JPnVav+6+Lm9VPCNk5FCPl62+nabvZ2txqk2ce5VHFHbosb96CgoVHk62Urd+2xswnVtU07/zmTWaIt0FBXa/s9vxWXN8REd01IW8YCPRMiMx8iPd3c46eVCKG8gopv9t3Ys/U9mcb1Vlye64ghdGVLLzQ3FX60uC1P8kVJLbO3H0/H83ncz9e8Q6/i8bhcLkf6Coc05BZuasYLhJCL0xC5ay9Fpr810Vq62rJySpwdTejXd+Lz/Wc483htn15GdglCyHVE265srY0QQk+eVSGEPtn0+yQ3q6AF42T2fyc+v3PZ3Y7LnzVtBDM5aGxCgYONEX1Vff735FnTnDTU2343Hj4qlkiotydaI1KRW7iV1Y0IIZk2j9baKklKKxwz0oxZkpFdkltQ8a7vCIRQbkHF8xc1Y13MmbVXrmWYGGlPcmu7sWVpMZjP5z5+Wnn+96R7CY9/3DVPZv+Pn1Y+eV71tmeHsisurcvOL3tbqppvx+fRxV1S9vJZUfUoqd+xy1cfqqvxPMaTe1OC3MI11BcghPILKjqvqqtvbhGJNTXaLx93HogxNtQOmD0KvbrAZS4uyyrqT/+S+NFiNz6/7cPk87mWFoOT0gs3bv1ja+g06+H6Mvu/HZ/f1QWuz8S2wi0srskrqKCLu6GxBaH27vryyvofT8e7jRlK7AUuIrlw353qxOdzQ7f9mZjyvLC45lrMo4AVZ5qaWxFCerqaBoMF4X+k5hVUlJS93Lzz6vnfk37cNY/+GncrLo/D4fz0299lFfUZ2SVzPzxlPkR38/oOc+zYWhud+1eSmYmQ/vZGq6hqKHhWVfCs6lrMI1tLw5rapoJnVUyX7624PEdbY+Zm3K177XU81EzPYLDgf3+Kvx2ff/1OzryPTldUNZB8gYtIvqtga2lw/PsFa/55yX3GfoSQhjp/+RI3+gsWh8PZt/39FRt/s/f8FiE0zFwv/FjQ+37O9BvvxOcHLRh3Jz7f1GUbQsjH0ybiyFLmmxnNZrg+l8v5Yddc5joYIbRo5c/0tMtt27jvQAj98O3cjz/woHf79qT2WrwVl+9gY2RqrIMQ4vO5R/cEfBwaPnnejy4jTP9zmWdsQsGUt+wG6qPBQfuD5DFBRjMObFPu2bx5Tc2tWbmlPC7Xeri+lqBDcH5tXdOjvDJtLQ1HWyOmCyC3oMLB89t/nQj2m+yQnlVsMFjLcqjsndSX9S2u7+yZPd153/bZ/XiqFEU1t4g1Nfhbvr12/veknPjPuoouVT2Ra8LeDe8wnS25LS5NU4M/2tlM7ipdHc0Jo4fKLLwdl8fhcLw9rDTU+eNc5Uwz29zSunzjbzwe55tNfv11kpk5pRZDhDraGpoa/L/+/XTfkTtH9wSQU7VykV64vXUrLs91hKn0BIgMiqJG++4teFZpMFjrz58/kmm/X8c/d0TeuJszysmsRSROy3yx7R/TF/mP7q+dY0qqcOnnzMn+Pe7Wh4smaGvJn0+vuUX85YapekLNSW5WMpe8r+nQjjn3/35aXFqnJ9R8Z5ItfeFLEHllCYMlAdt1M1jSyn/Tw/CIp3ceQKgCYAuKenrnwcPwCPuAMJk17S0ugkAQwDavAkGMFASCAMBaEHoHVAQULsASTBcFsAQtLsASFC7AUocOnpqs6OzftpWmJsHtMMAKHI6x6xj7gDCZjFEkfY1bkxUdu8Uf8nEBiyjIx2UK98F2LyN7M+jyBWzTTZdvaWoS5OMCFoJ8XIAnyMcFKgMKV5kgH7fPoHARgnxcDJFeuJCPiynSx5xBPi6miC5cyMfFF9GXCpCPiy9yW1zIx8UauS0u5ONijdzChXxcrJFbuJCPizVyCxfycbFGbuFCPi7WyL2rAPm4WGt/kDxivgDycaVXQT4ue0A+rizIx8UU6YXbW5CPyxKQj9s7kI+rBHLzcWGwJGC5bgZL2geEQT4uYBcF+bjS2WEQCALYpSeBIABghNyeM4A1KFyAJX5DQ72yzwGAbkCUPlARULgASx06eGC6KMAur6aLEiiYLqo+NyZh+0LIxwUsoiAfF6ZEBSzXTZdvWVoy5OMCFoJ8XIAnyMcFKgMKV5kgH7fPoHARgnxcDJFeuJCPiynSx5xBPi6miC5cyMfFF9GXCpCPiy9yW1zIx8UauS0u5ONijdzChXxcrJFbuJCPizVyCxfycbFGbuFCPi7WyL2rAPm4WGt/kDwmyAjycaVXQT4ue0A+rizIx8UU6YXbW5CPyxKQj9s7kI+rBHLzcWGwJGC5bgZLWvlvgnxcwC4K8nGZFhdBIAhgm1eBIEYKAkEAYC0IvQMqAgoXYAmi9AGWoMUFWILCBVjq0MED00UBdunJdFE1WdGxW/whHxewiIJ8XJgSFbBcN12+palJkI8LWAjycQGeIB8XqAwoXGWCfNw+g8JFCPJxMUR64UI+LqZIH3MG+biYIrpwIR8XX0RfKkA+Lr7IbXEhHxdr5La4kI+LNXILF/JxsUZu4UI+LtbILVzIx8UauYUL+bhYI/euAuTjYq39QfKI+QLIx5VeBfm47AH5uLIgHxdTpBdub0E+LktAPm7vQD6uEsjNx4XBkoDluhksaR8QBvm4gF0U5ONKZ4dBIAhgl54EggCAEXJ7zgDWoHABlvgNDfXKPgcAugFR+kBFQOECLHXo4IHpogC7vJouSqBguqj63JiE7QshHxewiIJ8XJgSFbBcN12+ZWnJkI8LWAjycQGeIB8XqAwoXGWCfNw+g8JFCPJxMUR64UI+LqZIH3MG+biYIrpwIR8XX0RfKkA+Lr7IbXEhHxdr5La4kI+LNXILF/JxsUZu4UI+LtbILVzIx8UauYUL+bhYI/euAuTjYq39QfKYICPIx5VeBfm47AH5uLIgHxdTpBdub0E+LktAPm7vQD6uEsjNx4XBkoDluhksaeW/CfJxAbsoyMdlWlwEgSCAbV4FghgpCAQBgLUg9A6oCChcgCWI0gdYghYXYAkKF2CpQwcPTBcF2KUn00XVZEXHbvGHfFzAIgrycWFKVMBy3XT5lqYmQT4uYCHIxwV4gnxcoDKgcJUJ8nH7DAoXIcjHxRDphQv5uJgifcwZ5ONiiujChXxcfBF9qQD5uPgit8WFfFyskdviQj4u1sgtXMjHxRq5hQv5uFgjt3AhHxdr5BYu5ONijdy7CpCPi7X2B8kj5gsgH1d6FeTjsgfk48qCfFxMkV64vQX5uCwB+bi9A/m4SiA3HxcGSwKW62awpH1AGOTjAnZRkI8rnR0GgSCAXXoSCAIARsjtOQNYg8IFWOI3NNQr+xwA6AZE6QMVAYULsNShgwemiwLs8mq6KIGC6aLqc2MSti+EfFzAIgrycWFKVMBy3XT5lqUlQz4uYCHIxwV4gnxcoDKgcJUJ8nH7DAoXIcjHxRDphQv5uJgifcwZ5ONiiujChXxcfBF9qQD5uPgit8WFfFyskdviQj4u1sgtXMjHxRq5hQv5uFgjt3AhHxdr5BYu5ONijdy7CpCPi7X2B8ljgowgH1d6FeTjsgfk48qCfFxMkV64vQX5uCwB+bi9A/m4SiA3HxcGSwKW62awpJX/JsjHBeyiIB+XaXERBIIAtnkVCGKkIBAEANaC0DugIqBwAZYgSh9gCVpcgCUoXIClDh08MF0UYJeeTBdVkxUdu8Uf8nEBiyjIx4UpUQHLddPlW5qaBPm4gIUgHxfgCfJxgcqAwlUmyMftMyhchCAfF0OkFy7k42KK9DFnkI+LKaILF/Jx8UX0pQLk4+KL3BYX8nGxRm6LC/m4WCO3cCEfF2vkFi7k42KN3MKFfFyskVu4kI+LNXLvKkA+LtbaHySPmC+AfFzpVZCPyx6QjysL8nExRXrh9hbk47IE5OP2DuTjKoHcfFwYLAlYrpvBkvYBYZCPC9hFQT6udHYYBIIAdulJIAgAGCG35wxgDQoXYInf0FCv7HMAoBsQpQ9UBBQuwFKHDh6YLgqwy6vpogQKpouqz41J2L4Q8nEBiyjIx4UpUQHLddPlW5aWDPm4gIUgHxfgCfJxgcqAwlUmyMftMyhchCAfF0OkFy7k42KK9DFnkI+LKaILF/Jx8UX0pQLk4+KL3BYX8nGxRm6LC/m4WCO3cCEfF2vkFi7k42KN3MKFfFyskVu4kI+LNXLvKkA+LtbaHySPCTKCfFzpVZCPyx6QjysL8nExRXrh9hbk47IE5OP2DuTjKoHcfFwYLAlYrpvBklb+myAfF7CLgnxcpsVFEAgC2OZVIIiRgkAQAFgLQu+AioDCBViCKH2AJWhxAZagcAGWOnTwwHRRgF16Ml1UTVZ07BZ/yMcFLKIgHxemRAUs102Xb2lqEuTjAhaCfFyAJ8jHBSoDCleZIB+3z6BwEYJ8XAyRXriQj4sp0secQT4upoguXMjHxRfRlwqQj4svcltcyMfFGrktLuTjYo3cwoV8XKyRW7iQj4s1cgsX8nEeodZyAAAAZUlEQVSxRm7hQj4u1si9qwD5uFhrf5A8Yr4A8nGlV0E+LntAPq4syMfFFOmF21uQj8sSkI/bO5CPqwRy83FhsCRguW4GS9oHhEE+LmAXBfm40tlhEAgC2KUngSAAYITcnjOAtf8Hr28uglRR5qoAAAAASUVORK5CYII="},52959:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-discrete-dirty-0910e099615f469d47dede0b1ab14040.png"},22174:(e,n,t)=>{t.d(n,{A:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzkAAAByCAIAAAD/B4h8AAAAA3NCSVQICAjb4U/gAAAAGXRFWHRTb2Z0d2FyZQBnbm9tZS1zY3JlZW5zaG907wO/PgAAGvNJREFUeJzt3XdUVNfaP/DnzABSHAaHoQhIEyRSRBHEKwbwh154sQSiGAULoqg3sRAr91qiaAwYMFkWjCUK+iIXIygqb0QwxBgsIYqJqAELtolSpCjNi8N5/9ivk/khAhoMI34/i5V1Zu9znrP35A+/a58yHM/zBAAAAAAqSdDZAwAAAACAF0JWAwAAAFBdyGoAAAAAqgtZDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUl1pnD+A1qm/kk8/VbD/5qKmzRwIAAADQJgHRTC/die7dtdQ5RSPXVX+3oL6RH7b+9yYijqMuOkUAAADoUlhoERDlLDFRxLUuu66WfK6micjfsVuYG6cmQFgDAAAAVfe0iduVx/9PwZPkczVhQ0Wsscuuqw3+VMZz9E2opqmRnlAo7OzhAAAAALRBLpfLSqqCEho4ns4uM2WNXXZdrYmIeFIT8AhqAAAA8EYQCoVqAp7nSXkhDc+BAgAAAKguZDUAAAAA1YWsBgAAAKC6kNUAAAAAVBeyGgAAAIDqQlYDAAAAUF3IagAAAACqC1kNAAAAQHUhq3VxHMe1vRMAAACoqpazmo2NDcdxHMc1NDSwlpqaGicnJ9a4e/fuv3CEAAAAAG+vdq2r8Tw/efLkgoICIlq0aNG0adNe86i6goaGBhZts7OzO3ssAAAA8KZq1++Brlq16tChQ0Q0cuTImJiY1zwkaM2GDRsePXo0ZswYFxeXzh4LAAAAvHZtr6ulpaWtWbOGiBwcHJKTkwWCPw5pamrasWPH3/72N11dXS0trXfeeWfx4sUPHz5kvadPn2YLS97e3soFAwICWHtGRkZHTkXFCIXCsWPHjh071sjIqAPLbtiwYfXq1RcuXOjAmgAAAKCy2lhXu3Tp0tSpU3mel0qlR44cEYlEii6e5ydOnLh//35FS2FhYWFh4f79+0+fPm1qajpkyBB7e/srV6788MMP9+7dMzMzI6JHjx4dO3aMiHr27Onn5/d6JqUS1NXVDxw40NmjAAAAgDdbG+tqY8eOrampIaLPP//cyspKuevrr79mQW348OHZ2dlnzpyJjIwkojt37sybN4/tM2PGDCLieT45OZm1HDp06MmTJ0Q0adIkoVDYwbN5edu2bevXr5+Ojo5YLHZ2do6NjVV0paen+/r6mpiYaGhoSCQSf3//X375hXXNmTOH47hRo0ZFRkZKJBKxWPzhhx82Njay3uzsbE5Js/vV5HJ5dHR0nz59NDQ0DA0NQ0JCbt++zbq++uorjuMsLS3Xr19vZGQklUoXL17M8zwR3bp1i1WTyWREFB4ezj7u3LmTHfvw4cPZs2ez0VpZWS1durS+vv41f3kAAADw+vEt6d27d7PdvLy8mu3D7pfS1tauqalRNA4dOpSI1NTUWGN5ebmGhgYROTs7sx38/f1ZwcuXL7d46o7itvae29p7svtlreyTlJREROrq6r6+vr6+vsbGxsrTDAkJEQqFdnZ2vr6+vXr1IiJjY+P6+nqe5z/66CMi0tTUlEqlXl5e7L0Yq1evZgfm5eV5eHgMGTKEzTQrK0v5pOzJDA0NDRcXFwMDAyIyNTUtLy/neX7r1q2sy9TU1NPTkx1+9OhRnufv37/v4eHh4eHBvk8bGxv28ciRIzzP19bWOjo6EpGenp6Li4u2tjYR+fn58Tz/ov/FAAAAoIJk98tYhlG0tJ3VxGIx20hLS1Ps8J///Ef5xrXn/frrr2zPDz74QBHOKioq1NXVicjd3f21zpNvX1Zjy35hYWHsY2Nj49mzZxW9hw8flslkbLumpoZ9Dyx4sawmFAqvXbvG8/zSpUuJyMjISLm4YllLOav9+uuvLMv+8ssvbB9nZ2ciWrduHf8sq3Ecx8oOHDiQiJYsWaJc1tTUlIh27Nih3Lhp0yYW4Kqrq3mev3nzpqamJhGdPn0aWQ0AAOAN8nxWa+N+tZCQkNDQ0BEjRrDQMGrUKBa2Hj161NTU1MqBdXV1bGPGjBkpKSlElJSUZG1tzS4UhoaGtn7ev4atrS0RJSQklJSU+Pv7jxkzxt3dXdHr6en573//++LFi9XV1U1NTXK5nIju3r2r2MHFxcXGxoaIgoKCYmJiSkpKysvLpVJpK2c8ceIEEamrqy9ZsoS1sEcx8vLyFPsYGRmxstbW1ufPny8rK2tzIuwya319/fjx41kLS9LKZQEAAOBN1EZWi4+P19XV9fPzO3bs2PXr17ds2RIREUFEIpGI4zie501MTM6dO/f8gYaGhmzDx8fH2tr65s2bycnJbLlOU1NzwoQJHT2RVzF37tyrV68mJSVlZGRkZGTMmTNnyZIl0dHRRFRZWenu7n7t2rVmh7Cb7ZgePXo022gzq7FkVl9fn5mZqdz++PFjxXa3bt3YBstbrWdi5bIymYzdzdZiWQAAAHgTtfFsAbs7av369Sw3REVFVVRUsHYHBwciun//flVVldn/r7S0lB1IRBzHhYWFEVFxcTFb/gkICNDT03udk2ovLS2t3bt3l5WVpaensyuhMTEx7DJlWloaC2p79+5lFxZ79uzZ7PA7d+6wDcViG7v/rBUs1Zmbmzdb8MzKyvozE2Flp0yZ0qzssmXL/kxZAAAA6HTt+t0CJycndtWysrIyKiqKNYaHhxMRz/O+vr5xcXHHjx//9ttvY2Ji+vfvr3gOlJk2bZryI5+q87MH586du337tlgsHjNmzM6dO9kDBCx4VVVVEZGmpuakSZN0dXVv3Ljx4MGDZof/9ttv6enpjY2NX3zxBREZGRnp6+u3fkb2qrk7d+4ont+sr6/fs2fPd999184xa2lpEVFJScnzZQ8ePKh471ppaemaNWtKS0vbWRYAAABUVIv3tSmeLWCPPfI8L5PJ2NOF6urqRUVFPM/L5fLAwMAWa3p4eDQrOHr0aNZlZmYml8tf9X67l9CeZwuWLVsmEAicnJxGjRrl5ORERDo6Ovfv3+d5Pj8/n+XL8PDwzZs3v/POO2z8W7du5Z89W8CSGbuBj4iioqJY2XHjxik/B+ro6Mie2SwtLeV5Pjg4mLVLpVILCwu2YLl3717+2bMFFhYWrA57LIO9304hKCiIiNTU1Nzc3BTPgT569MjOzo6IOI7r1auX4u27LHd29FcLAAAAr8vzzxa0a12NiExMTBYsWEBEjY2NixcvJiKBQJCampqYmOjj4yORSNTU1AwMDNii2vO/Q8USBhFNmTKl9QdI/0re3t7+/v6VlZVZWVkymczb2zsjI8PY2JiI+vfvn5KS0q9fv6SkpI0bN86YMaPZ6+WIaPDgwXFxcSKRSE9Pb86cOez1ckSUl5eXm5vLnsEkooKCgtzc3NzcXHav2549e2JjY52cnGpqasrLy62tradPnz548OB2jjkmJsbPz09HR+fnn3/Ozc1lq30ikSg3N3fu3Lnm5uYPHjx48uSJs7Pz0qVLJRJJh3xRAAAA0Fk4nuf/gtNMnTp1z549RFRUVMSevnzdBn0qI6JD07uZGLd2s/+rmTNnzpYtW0aOHHn06NEOL96x2CMgnT0KAAAAaJffH5QHfP2EiH5aZspa2vXb7a9MJpM9fvz4hx9+YG+d/fvf//7XBDUAAACAruH1ZrUPPvggNzeXbaurq7PfgAcAAACAdvorbh0TCoUODg4HDx4cNGjQX3C6v8DmzZt5nlf9C6AAAADwpnu962o//vjja63fCgERz9HTJk4ul6vCj8R3FtysBgAA8KaQy+VPmziOI07pX+/Xm9U60Uwv3a9OPtqVx4e5VakJkFcAAABA1T1t4nbl8TxPs7x0FY1d9iHB+kZ+2Prfm4g4jrroFAEAAKBLYaFFQJSzxERLnfu/xq6a1YiovpFPPlez/eSjtn9QEwAAAKCzCYhmeulOdO+uCGrUtbMaAAAAwJtOVX5CAAAAAACeh6wGAAAAoLqQ1QAAAABUF7IaAAAAgOpCVgMAAABQXc3fhVtXV9sp4wAAAACA52FdDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUF7IaAAAAgOpCVgMAAABQXchqAAAAAKoLWQ0AAABAdSGrERH5+fl98MGEjq2Znn54165dHVsTAAAA3jbIakREFhaW5ua9OrZmenr6rl27O7YmAAAAvG2a/x7o22nbtq86ewgAAAAALWhhXa2yslJPr8fGjZuUGwcP/tuECRMVHzMyMjw9vfT1pb16mUdERNTX1yvv3KuX+YoVK3fs2Onk5CSR6Ds5OV28eJF15eTkeHl56+tLzcx6hYVNLysra+dA7969O2XKFEtLK319qZOT08qVnyi6cnJy3n9/rLV17x49JA4OjlFRaxobG1nX06dPdXS6R0ZGjh49Rl9famNjGxsbq1xWR6c7+2vxGuiLpvnTTz/p6HRPTk4eOXKUVGrg4OC4f/9+xVESib6OTveUlJT8/HxF/erqatbb1NS0YcMGZ2dnNtr4+K3t/AYAAADgLdTCulqPHj18fHzS0tLmzZvLWq5fv3Hp0qVFixaxjykpKdOnzxg3buyKFcsfPHiwcuUn9fUNzZamMjIydHV1v/zyS2Nj49zc00+fPiWi/Pz8gIBAT0/PpKT/LisrW758RWDg+z/8cFIgaPtS7NSpodXV1Zs2bZRI9IuKCs+cOavounSpwNHRcerUqRKJ5Pr1a598sqqurjY6OlqxQ3z81ri4uMTEhBMnvps5c6aRkdHkyZNZ15Url1nx58/Y5jTXrFm7efOmvn37fvrpulmzZr/77rs9e/YkoosX83meX7o08ubNm998838ZTiQSsY158+bv3bt34cKF77479Ny5c//617/EYt2QkJA2vwEAAAB4C3E8zyt/rqurJaKUlJSwsOlXr14xNzcnopiYmLi4DbduFWtra8vlclvbPnZ2dt9++z/skEOH0idPnnzp0q+WlpaspVcv86ampsLC37p3765cPCxsemZm5vXr17S0tIjo4MFDkyZNOnw43cfHp/VRyuVyPb0ea9eumT9/fptTio6O3rx5y717d4no6dOnYrHesGHDjh49wnqnT59x4cKF/PwLyof4+fmJxXopKf9WPmMr0/zpp5+GDft/n322bt68eURUUlJibd179+5d48ePV55sUVHRjz+eUj7R1atXXV3dli9f9s9//pO1LFy48NixzMuXC9qcFwAAALyFWl7QGjlylJaW1sGDB9nHAwdSR47019bWJqIrV66UlJQEB/9xPdTT892mpqZLly4pVxgxYnizoEZEFy6c9/DwYEGN7UNEP//8s2KH2tra6mcU1zGJSCgU2tvbb9u2PSEh4bfffmtqalIuW11dvWLFSldXN2PjnhKJ/mefRVdWVrKVPMbNzU2x7erqWlRU1NDQ0Pr30p5p9uvXj20YGRkJBIIHDx60XpOIvvsuh4gmTvyj7Lvvet66dUtxhRQAAABAWctZrXt3nf/6L7/U1DQiKioqunLlSlBQEOt6+PAhEc2dO08i0Wd/Nja2RCST/a5cwcTE9Pmy1dWPJBKJ0lm6q6urV1X9EVOCg0NMTEzZX2pqqvKx33yzf+jQoVFRawYOdLW27q38OoyQkEn79u2LiJh//Hjm2bNnIiIiiEg5q+nqihTbYrEuEZWWlrb+vbRnmiy8MhzHKYfL1su6uAxUlA0NDSUimUzW5rEAAADwFnrhc6DjxgUFBwffvn37wIEDYrF4+PDhrJ2FrS+//GLIkCHK+xsaGip/FAqFz9cUi3UrKioUH2tqahobG/X0xIqW6OjPKiuXsu0+fWyVjzU3N9++fRsRFRYWrlz5yfz5EcOGDbOysiotLc3JydmxY3twcDDbUzmlMeXlD5ttS6XSF038pab5siQSCcdxJ09+361bN+V2CwuLP1MWAAAAuqoXZjVf37+LRKK0tLTU1LSAgAANDQ3Wbm9vb2BgcPnyZbYg9FJcXAYeO3asrq6OrUhlZh4nIldXV8UOffv2bbOInZ3dwoULjh49+vvv962srGpra4lIX1+f9fI8f+zYsWaHnDhx4tNP1yq2bW1tlJfEWvRnpsmIxbo1NTXNGocN8+Z5vri4eMyYMa9WFgAAAN4qL8xqmpqao0eP3rx5y4MHD2JjP//jADW1des+nTVrdn19g5+fr7q6emFh4cGDh5KS/tvExKT1k3300YcHDhwYNy7oo48+LC0tXbnyE2dnZ29v7zZHWVFRERj4/oQJE955x66uri42Ns7Q0NDZ2ZmILCwsbG1tN23a7OLiQkTr1q27d+9es8Nv3Lgxc+assWPfz8nJyc7Ojo/foij7+PFjImpoeKKuXnf79m0iEovFenp6f2aajJOT044dOxMSEtzd3YVCoY2NjUAgcHBwmDx58syZsy5fvuzm5lZbW3fx4sXz588fPpzenpoAAADwtmntXbjjxwft27fP0NDQ09NTuT04OFhPT2/Dhg0pKSkCgaB3795+fn49evRo82QDBw5MS0uNilozefIUTU1NX1/fmJjoFq+WNqOlpeXg4LBt21d3797T0dEZNGjQpk0bu3fXISKBQLB/f8rHHy9wcHDU0tIKCAhYunTJihUrlQ+PiIgoKCgICZkkFotXrfpk6tSprH358hWJiYmK3eztHYhowYIFa9ZE/ZlpMpMmTbpwIX/16qiysjKe53//XSYWi4koPn6LvX3fhITE9es/F4lE9vb2Eyd28M9bAQAAQJfR8js7ugz2zo6YmJg5cz7q7LEAAAAAvDT8HigAAACA6kJWAwAAAFBdXfwaKAAAAMAbDetqAAAAAKoLWQ0AAABAdSGrAQAAAKguZDUAAAAA1YWsBgAAAKC6kNUAAAAAVFfzd3YAAAAAgOrAuhoAAACA6kJWAwAAAFBdyGoAAAAAqgtZDQAAAEB1IasBAAAAqC5kNQAAAADVhawGAAAAoLqQ1QAAAABUF7IaAAAAgOrqnKzm7e0dEBDQsTU3bNhw/Pjxjq35mlRUVKxataqoqKizBwIAAACqrnOympWVlYWFRcfWfLOy2urVq5HVAAAAoE1qnXLW3bt3d8p5AQAAAN4sL1xXO3XqlKenp56enkgkGjBgQHJysqIrOzt75MiRPXv27Natm7W19YoVKxobGxVdHMd9+eWXTk5O3bp1c3BwyMjIUC7LPfP8NdCmpqaYmJg+ffqwshs3blR0nT17luO4vXv3Dh8+XFtb29raet++fcpdHMfJZLK4uDi23b9///aUbV0r0zQzMwsNDbW0tLS0tDx8+LCDg4NUKk1ISFAcW1BQMHr0aLFYrKOjM2rUqOLiYtYeHR3NcZytrS0RjR49mo02IiKinUMCAACAtw7fkrKyMpFI9N5772VlZWVlZUVHR69bt07RGxcXFxkZmZqa+v3332/fvl0qlX788cesKysri4gMDAxOnDhRWloaGRmprq5eWFioOLa4uLi4uNjd3f29995rdtLw8HA1NbXly5dnZWVFRUWpq6snJCSwrjNnzhCRpaXl8ePHZTJZeHi4hoaGTCbjeb6hoYHVNDY2Dg8PZ9usq82yrWtlmqampoMGDcrKyrKwsNDQ0Pjmm2/CwsKMjIxY79WrV1nAPXDgwKFDh9zc3GxtbRsbG3mer6qqKi4u/v7774no66+/ZqN9+PBhe8YDAAAAb6GWs1pOTg4R5eXltadEVFSURCJh2yyrrV27ln2Uy+Xm5uazZ89udoiXl1ezrFZQUEBEq1evVrTMmTPHysqKbbOsFhsbyz7ev3+fiJKSkpQrmJqaLly4sNmJWi/7UpSnaWpqGh0dzfP89OnTHR0deZ5n8auyspLn+XHjxunr6ysSmEwm09DQSExMVJS6du0aER05cuQVhgEAAABvlZavgdrZ2Wlqai5atCg1NfXu3bvNequqqiIjIx0dHcVisaamZlRUVEVFxdOnTxU7uLu7sw2BQODq6pqfn9/m8l52djYRTZ48WdHi7e1dXFxcVVWlaFFc2TQ2NhYIBCyx/cmycrm86pnHjx+3f5q6urrsv2xDJBIRUU1NDT27eCqRSNieJiYmffr0uXDhQpujBQAAAGim5azWs2fPzMxMbW3t0NBQc3Nze3t7trLFBAUF7dmzZ9GiRSdPnrx48eLixYuJSDmrsfjCiMXikpKSNsdRXl5ORH379tV8ZuLEiUR07949xT46OjqKbY7jFHeP/ZmyeXl5PZ4ZMGCA8rGtT5PjOCISCASKDdbLwl9SUpKmksuXLytPBAAAAKCdXvgcqKenp6enp1wu//HHH//xj38EBwezG+RLSkqys7MTExOnTJnC9lROaQxLSIptQ0PDNsehr6/Pcdy5c+e6deum3G5lZdX+ybxCWQcHh1OnTrFtLS0txQ7tmWaLhEKhWCweP378ggULlNvZwhsAAADAS2njnR1CodDLy2vKlCkrV66Uy+VCobC2tpaIpFIp24Hn+WZPehJRZmamv78/ETU0NJw6dWr8+PFtjsPHx4fn+Zs3bwYGBr7KPIjEYjG7BPlSZUUi0dChQ59vb880X8THx+f8+fO2trZCofBFQ6VnF0wBAAAAWtFyVktPT09ISAgMDDQ3N799+/bGjRtHjBjBkoelpaWdnd0XX3zh6upKRKtXr37+hraEhAQjI6N+/frFx8fX1NR8/PHHrP3hw4fsnrCGhoa6urpbt24RkVgs7tGjh5OT07Rp00JDQy9duuTu7l5bW3vhwoW8vLzMzMx2zsTZ2Tk9PT0gIMDS0lJTU9PS0pKIXrlse6b5ImvWrHF3dx8xYkR4eLhUKr1161ZGRkZISEhQUBDbwcDAwMTEJD4+3tLSUk9PTyKRtGfpEQAAAN5GLT5xcOXKlffff9/MzExDQ8PMzGzWrFnl5eWK3qtXr/r4+Ojo6BgYGMyePTs6OpqI6uvr+WfPgSYmJrq6umpoaPTt2/fw4cOKA6dPn/78AJYuXcp65XJ5bGxs3759NTQ0pFKpt7f3zp07WRe7W+7MmTOKUkKh8LPPPlMec3Fxsa+vr56eHhE5Ozsr2lsp27pWpmlqarp161ae5xcuXOjh4cHzPHt+ori4mB1bUFAQGBgokUg0NTVtbW1nz55948YN5eLZ2dkDBgxgV13nz5/fnvEAAADAW4jjeb4Dk192dvaIESPy8/OV30YLAAAAAK+mc34PFAAAAADaA1kNAAAAQHV18DVQAAAAAOhAWFcDAAAAUF3IagAAAACqC1kNAAAAQHUhqwEAAACoLmQ1AAAAANX1vxX3UZBynRtLAAAAAElFTkSuQmCC"},86965:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/filter-string-dirty-dadee973219a779404cf2c4443cc5ee3.png"},37624:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/sort-updown-clean-18a717b9686dfecb04d47a3f794daf68.png"},12603:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/sort-updown-dirty-2148a91f5adf2a2c0272b096834b8c98.png"},2119:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/streamedtable-4cf5d169c74626898e013335a0a4d34a.png"},28453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>o});var i=t(96540);const s={},a=i.createContext(s);function l(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f6484bf.692c7e86.js b/assets/js/1f6484bf.692c7e86.js deleted file mode 100644 index 93d2521e34..0000000000 --- a/assets/js/1f6484bf.692c7e86.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5680],{47369:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"developer/setting_up_vscode_dev_env","title":"Setting up a Rucio Developer environment using Visual Studio Code","description":"Local Setup vs Remote Setup","source":"@site/../docs/developer/setting_up_vscode_dev_env.md","sourceDirName":"developer","slug":"/developer/setting_up_vscode_dev_env","permalink":"/documentation/developer/setting_up_vscode_dev_env","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/setting_up_vscode_dev_env.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"setting_up_vscode_dev_env","title":"Setting up a Rucio Developer environment using Visual Studio Code"},"sidebar":"docs","previous":{"title":"Setting up a Rucio Developer environment using IntelliJ Ultimate","permalink":"/documentation/developer/setting_up_intellij_dev_env"},"next":{"title":"Contributing Guide","permalink":"/documentation/contributing"}}');var o=i(74848),t=i(28453);const r={id:"setting_up_vscode_dev_env",title:"Setting up a Rucio Developer environment using Visual Studio Code"},c=void 0,d={},l=[{value:"Local Setup vs Remote Setup",id:"local-setup-vs-remote-setup",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"VSCode",id:"vscode",level:3},{value:"Remote Only: Additional Setup VSCode",id:"remote-only-additional-setup-vscode",level:3},{value:"VSCode Extensions",id:"vscode-extensions",level:3},{value:"Docker and Docker Compose",id:"docker-and-docker-compose",level:3},{value:"If you get a docker-compose: command not found error",id:"if-you-get-a-docker-compose-command-not-found-error",level:4},{value:"SSL Certificates",id:"ssl-certificates",level:3},{value:"Setting up Rucio and Configuring VSCode",id:"setting-up-rucio-and-configuring-vscode",level:2},{value:"VSCode Tasks",id:"vscode-tasks",level:2},{value:"Starting Rucio",id:"starting-rucio",level:3},{value:"Stopping Rucio",id:"stopping-rucio",level:3},{value:"Debugging Overview",id:"debugging-overview",level:2},{value:"Debugging Rucio Server",id:"debugging-rucio-server",level:3},{value:"Debugging Rucio WebUI",id:"debugging-rucio-webui",level:3},{value:"Debugging Rucio CLI Clients ( rucio-admin and rucio)",id:"debugging-rucio-cli-clients--rucio-admin-and-rucio",level:3},{value:"Debug rucio cli client",id:"debug-rucio-cli-client",level:4},{value:"Debug rucio-admin client",id:"debug-rucio-admin-client",level:4},{value:"Debugging Rucio Tests",id:"debugging-rucio-tests",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"local-setup-vs-remote-setup",children:"Local Setup vs Remote Setup"}),"\n",(0,o.jsx)(n.p,{children:"It is possible to run the containers for rucio development locally or on a remote VM."}),"\n",(0,o.jsxs)(n.p,{children:["For local development machines with limited resources ",(0,o.jsx)(n.code,{children:"(<16 GB RAM, < 4 Cores)"}),", it is recommended to run the containers on a remote VM. This will allow you to use your local machine for other tasks while the containers are running on the remote VM."]}),"\n",(0,o.jsxs)(n.p,{children:["Local development has been tested only on Linux hosts.\nRemote development has been tested on Linux(for the remote VM) and Linux/MacOS(for the local instance of vscode).\nThe additional steps required for setting up a remote development environment are described in the sections begininng with ",(0,o.jsx)(n.code,{children:"Remote Only: "}),". These sections can be ignored if you are setting up a local development environment."]}),"\n",(0,o.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,o.jsx)(n.h3,{id:"vscode",children:"VSCode"}),"\n",(0,o.jsxs)(n.p,{children:["Install ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/Download",children:"Visual Studio Code"})]}),"\n",(0,o.jsx)(n.h3,{id:"remote-only-additional-setup-vscode",children:"Remote Only: Additional Setup VSCode"}),"\n",(0,o.jsxs)(n.p,{children:["For development on a remote VM, you will need to install the ",(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack",children:"Remote Development Extension Pack"})]}),"\n",(0,o.jsxs)(n.p,{children:["You should setup SSH access to your remote VM. For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/ssh",children:"Connecting to a remote host"})]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Remote-SSH: Open SSH Configuration File"}),"\n",(0,o.jsx)(n.img,{alt:"Open SSH Configuration File",src:i(67403).A+"",width:"609",height:"270"})]}),"\n",(0,o.jsxs)(n.p,{children:["You will be asked to create a new SSH configuration file or select an existing one. If you have an existing SSH configuration file, select it. If you do not have an existing SSH configuration file, select ",(0,o.jsx)(n.code,{children:"Create New File"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Update the SSH configuration file:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host \n HostName \n User \n"})}),"\n",(0,o.jsxs)(n.p,{children:["Additionally, you can use the ",(0,o.jsx)(n.code,{children:"IdentityFile"})," option to specify the SSH key to use for authentication. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host \n HostName \n User \n IdentityFile ~/.ssh/\n"})}),"\n",(0,o.jsx)(n.p,{children:"If your remote VM is behind a firewall, you will need to setup a proxy. For example, at CERN, we can use lxplus as a ssh proxy to connect to the remote VMs, which are not accessible outside the CERN network. The following is an example of an SSH configuration file that uses lxplus as a proxy:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host lxplus\n HostName lxplus.cern.ch\n User \n\nHost \n HostName \n User \n ProxyCommand ssh -q -W %h:%p lxplus\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/ssh",children:"Connecting to a remote host"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Test connection to Remote VM"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Remote-SSH: Connect to Host..."})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Select the remote VM from the list of hosts"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Depending on your SSH Configuration, you may be prompted for the password/s in the following order:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"remote user on the proxy host"}),"\n",(0,o.jsx)(n.li,{children:"ssh key password or the password of the remote VMs user."}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The bottom right corner of VS Code will show the status of the connection. If the connection is successful, you will see ",(0,o.jsx)(n.code,{children:"SSH: "})," in the bottom right corner:"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Successful Connection",src:i(76587).A+"",width:"354",height:"108"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["For troubleshooting and Tips/Tricks, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/troubleshooting",children:"Troubleshooting"})]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"NOTE for remote development"}),": From hereon out, all the instructions should be run in the VSCode instance connected to your remote VM. ( i.e. the VSCode instance that shows ",(0,o.jsx)(n.code,{children:"SSH: "})," in the bottom right corner)\nYou can use the terminal in the VSCode instance to run commands on the remote VM directly. To do so, open the terminal in VSCode instance connected to your remote VM by clicking on ",(0,o.jsx)(n.code,{children:"Terminal"})," in the menu bar and then clicking on ",(0,o.jsx)(n.code,{children:"New Terminal"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"vscode-extensions",children:"VSCode Extensions"}),"\n",(0,o.jsx)(n.p,{children:"Install the following extensions:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-python.python",children:"Python"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance",children:"Pylance"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker",children:"Docker"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers",children:"Remote - Containers"})}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["VSCode comes with a plethora of extensions that can significantly improve your development experience. For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/editor/extension-gallery",children:"Extensions"})]}),"\n",(0,o.jsx)(n.h3,{id:"docker-and-docker-compose",children:"Docker and Docker Compose"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Install ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})]}),"\n",(0,o.jsxs)(n.li,{children:["Install ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"})]}),"\n"]}),"\n",(0,o.jsxs)(n.h4,{id:"if-you-get-a-docker-compose-command-not-found-error",children:["If you get a ",(0,o.jsx)(n.code,{children:"docker-compose: command not found"})," error"]}),"\n",(0,o.jsxs)(n.p,{children:["Docker has deprecated the ",(0,o.jsx)(n.code,{children:"docker-compose"})," command in favour of ",(0,o.jsx)(n.code,{children:"docker compose"}),".\nTo turn on ",(0,o.jsx)(n.code,{children:"docker compose"})," support in ",(0,o.jsx)(n.code,{children:"docker"})," command, please make sure you have installed the ",(0,o.jsx)(n.code,{children:"docker-compose-plugin"})," package from the ",(0,o.jsx)(n.code,{children:"docker-ce-stable"})," repository."]}),"\n",(0,o.jsxs)(n.p,{children:["The full command to install ",(0,o.jsx)(n.code,{children:"docker"})," and ",(0,o.jsx)(n.code,{children:"docker compose"})," on RPM-based installations is:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"yum install docker-ce docker-compose-plugin\n"})}),"\n",(0,o.jsx)(n.h3,{id:"ssl-certificates",children:"SSL Certificates"}),"\n",(0,o.jsxs)(n.p,{children:["If you would like to debug the rucio webui and x509 authentication capabilities of the rucio server, you will need to obtain SSL certificates for your development environment. For remote VMs, you can request them from your IT department or you can use letsencrypt to generate a certificate. For local development machines, you can use ",(0,o.jsx)(n.a,{href:"https://github.com/FiloSottile/mkcert",children:"mkcert"})," to generate a certificate."]}),"\n",(0,o.jsxs)(n.p,{children:["Whatever route you go, you should have a ",(0,o.jsx)(n.code,{children:"hostcert.pem"})," and a ",(0,o.jsx)(n.code,{children:"hostkey.pem"})," file accessible for your development environment."]}),"\n",(0,o.jsx)(n.h2,{id:"setting-up-rucio-and-configuring-vscode",children:"Setting up Rucio and Configuring VSCode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Clone the rucio repository"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"gh repo clone rucio/rucio\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Clone the vscode configuration repository"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"gh repo clone maany/rucio-vscode-dev-env\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Move the vscode repo inside the rucio repo"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv rucio-vscode-dev-env rucio/.vscode\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Copy the SSL certificates to the ",(0,o.jsx)(n.code,{children:"rucio/.vscode/certs"})," directory"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open VSCode. If you are using a remote VM, open the VSCode instance connected to your remote VM."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Go to ",(0,o.jsx)(n.code,{children:"File"})," -> ",(0,o.jsx)(n.code,{children:"Open Folder"})," and select the ",(0,o.jsx)(n.code,{children:"rucio"})," folder"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Edit the rucio/.vscode/docker-compose.yml and change the ",(0,o.jsx)(n.code,{children:"RUCIO_HOST"})," environment variable for the rucio-dev container to ",(0,o.jsx)(n.code,{children:"http://localhost"})," if you are using a local development environment or to the fqdn and port of your remote VM if you are using a remote development environment.\n",(0,o.jsx)(n.img,{alt:"RUCIO_HOST",src:i(75253).A+"",width:"1092",height:"520"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Add the default url for webui in ",(0,o.jsx)(n.code,{children:"rucio.cfg.template"}),", which is required to handle Cross Origin Requests (CORS) in the webui. Add the following line to the ",(0,o.jsx)(n.code,{children:"[webui]"})," section of ",(0,o.jsx)(n.code,{children:"rucio.cfg.template"}),":\n",(0,o.jsx)(n.code,{children:" urls = "})]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If your server is running on a remote VM, but webui will be running locally, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If both the server and webui are running locally, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),". In this case, you can set the ",(0,o.jsx)(n.code,{children:"urls"})," to ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If both the server and webui are running on the same remote VM, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://:3000"}),". In this case, you can set the ",(0,o.jsx)(n.code,{children:"urls"})," to ",(0,o.jsx)(n.code,{children:"http://:3000"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"vscode-tasks",children:"VSCode Tasks"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsx)(n.li,{children:"You should see a list of pre-configured tasks"}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"tasks",src:i(46399).A+"",width:"599",height:"334"})}),"\n",(0,o.jsx)(n.p,{children:"These tasks are helpful utilities for your to quickly start/stop rucio containers and to setup different types of debuggers ( server, webui, pytest, clients, ...)."}),"\n",(0,o.jsx)(n.h3,{id:"starting-rucio",children:"Starting Rucio"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"start-rucio"})]}),"\n",(0,o.jsx)(n.li,{children:"This will start and initialize the rucio development environment. The first time you run this task, it will take a while to fetch and build the docker images. Subsequent runs will be much faster."}),"\n"]}),"\n",(0,o.jsx)("video",{width:"100%",controls:!0,children:(0,o.jsx)("source",{src:"/documentation/img/vscode/start_rucio_task.mp4"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["After the command has finished, you can run ",(0,o.jsx)(n.code,{children:"docker ps -a"})," to check if all the containers are up and running. You should see something like this:\n",(0,o.jsx)(n.img,{alt:"docker ps -a",src:i(49962).A+"",width:"1515",height:"453"})]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"stopping-rucio",children:"Stopping Rucio"}),"\n",(0,o.jsxs)(n.p,{children:["To take down all the containers, run the ",(0,o.jsx)(n.code,{children:"stop-rucio"})," task. This is equivalent to a ",(0,o.jsx)(n.code,{children:"docker-compose down"})," command."]}),"\n",(0,o.jsx)(n.h2,{id:"debugging-overview",children:"Debugging Overview"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio server, webui, clients, etc."]}),"\n",(0,o.jsx)(n.p,{children:"The debugging process for Rucio in VSCode is broken down into 3 steps:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Start the process inside the ",(0,o.jsx)(n.code,{children:"rucio-dev"})," container that you want to debug"]}),"\n",(0,o.jsx)(n.li,{children:"Attach the debugger to the process"}),"\n",(0,o.jsx)(n.li,{children:"Insert breakpoints in the code and start debugging"}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are done debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-server",children:"Debugging Rucio Server"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio server."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server:debug"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Attach the debugger to the rucio server by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Server: Debug"})," from the dropdown menu."]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"attach to rucio-server",src:i(80759).A+"",width:"393",height:"514"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio server."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"You can now set breakpoints in the rucio server code and debug the server."}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["After you have finished debugging, you can detach the debugger from the rucio server by clicking on the ",(0,o.jsx)(n.code,{children:"Stop"})," button in the debug toolbar."]}),"\n",(0,o.jsxs)(n.p,{children:["**NOTE: ** After detaching the debugger, run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n",(0,o.jsx)("video",{width:"100%",controls:!0,children:(0,o.jsx)("source",{src:"/documentation/img/vscode/rucio-vscode-server-debug.mp4"})}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-webui",children:"Debugging Rucio WebUI"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio webui."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio webui, you will need to start the rucio server in non-debug mode and the rucio webui in debug mode."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-ui:debug"})]}),"\n",(0,o.jsxs)(n.li,{children:["Attach the debugger to the rucio webui by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"UI: Debug"})," from the dropdown menu."]}),"\n",(0,o.jsxs)(n.li,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio webui."]}),"\n"]}),"\n",(0,o.jsxs)(n.h3,{id:"debugging-rucio-cli-clients--rucio-admin-and-rucio",children:["Debugging Rucio CLI Clients ( ",(0,o.jsx)(n.code,{children:"rucio-admin"})," and ",(0,o.jsx)(n.code,{children:"rucio"}),")"]}),"\n",(0,o.jsx)(n.h4,{id:"debug-rucio-cli-client",children:"Debug rucio cli client"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio cli clients."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio cli clients, you will need to start the rucio server in non-debug mode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Then, you need to start the ",(0,o.jsx)(n.code,{children:"rucio-cli:pre-debug"})," task to inject the debug configuration into the rucio cli clients."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-cli:pre-debug"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Start the ",(0,o.jsx)(n.code,{children:"Rucio:CLI Debug"})," launch configuration by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Rucio:CLI Debug"})," from the dropdown menu."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio cli clients."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["After that, you should open a shell inside the ",(0,o.jsx)(n.code,{children:"rucio-dev"})," container"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"docker exec -it rucio-dev bash\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Insert breakpoints in the rucio cli clients code."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Run a rucio cli command to trigger the breakpoint."}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are finished debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the debug process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"rucio-cli:post-debug"})," task to remove the debug configuration from the rucio cli clients."]}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"debug-rucio-admin-client",children:"Debug rucio-admin client"}),"\n",(0,o.jsxs)(n.p,{children:["The instructions are the same as for the ",(0,o.jsx)(n.code,{children:"rucio"})," client, except that you need to start the ",(0,o.jsx)(n.code,{children:"rucio-admin:pre-debug"})," task to inject the debug configuration into the rucio-admin client."]}),"\n",(0,o.jsxs)(n.p,{children:["After debugging, you should run the ",(0,o.jsx)(n.code,{children:"rucio-admin:post-debug"})," task to remove the debug configuration from the rucio-admin client."]}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-tests",children:"Debugging Rucio Tests"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio tests."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio tests, you will need to start the rucio server in non-debug mode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Then, you should open the file containing the test you want to debug in VSCode."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Insert breakpoints in the test code."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Start the ",(0,o.jsx)(n.code,{children:"rucio-pytest:debug"})," to start the test in debug mode"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Attach the debugger to the test by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Pytest: Debug"})," from the dropdown menu."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio tests."]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are finished debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the debug process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},75253:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-compose-rucio-host-465a74fa33e82533f549c7342c5942e2.jpg"},49962:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-ps-7e66472c5b3eaab849aed2e0fe06e354.jpg"},67403:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/remote_ssh-b59c7e945ebcc026fee6dd82cfebe0ab.jpg"},76587:(e,n,i)=>{i.d(n,{A:()=>s});const s="data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAAWIAAABsCAYAAABQIbi+AAAAAXNSR0IArs4c6QAAH3dJREFUeF7tnQ1UVWW6gJ/Gw4+KQB3/TopgIKZIJsfRQA3FxFKupU465hrF8ZqOS6Ep5TYTeLth5UWnBmt5/ZkmdFLT/BsHKRlRUQN1Oo4GaP4lioUplAoSf83c9W1+PCDIYXNU1Hev5Vpy2N93vu/Zm2e/5/3evc8DRqPx315eXtzN26VLl+7m4cvYhYAQuM8JPCAivs/PAJm+EBACd5yA/UXsYsTzYS8eNrnQxqkNjo6VcywtpaCkgMLcb8n+9iz5hfabu0TE9mMpPQkBIXD7CdhPxC4mevn74mVsUzGL0gLy8wsppYQSnHDCERejkTaVYi7Iz+ZERia5dhCyiPj2nzjyjkJACNiPgF1E7OJpJsjfhCOl5Gcf50T2TSJeFTF7+dLdy6jtn5uRhuVs02wsIrbfCSE9CQEhcPsJNFnExl7BBHq1gYJsLJZGRLgqgjabqWiaTmpmvu7Zi4h1o5OGQkAINAMCTRKxi2cgg/2NlOZmkGY5i3Vc62g04eX1MEZHFy3yLSzI59vsbHILS62m7YKnOQh/kyP5GbtJ1xkZi4ibwZkkQxACQkA3Af0idvEleLAvbQpOsDv1hJWEXTCZzZhNlblilS4GqtbsCrItpGfmaq9VbC74Bg/Gt00BJ3anckJHlkJErPv4S0MhIASaAQGdInbEMzAUf2MBGbtTsQ5kr6cqcsnIzOBsfoVyHY2e+PfyR/n5hlSEiyfBg/1pk59BcvpZK0nbRkhEbBsn2UsICIHmSUCfiF16ETzYC6fsdJKtc7vVUXI26amZ3Jj1NdIrOBCvOqJfY69QAr1KdEXFIuLmeXLJqISAELCNgC4Ru/QKZrAXN0jTpVcog70cybUkYsmtZwAmM2FmEwXZu0nNtMpDVEqc2q/bMA8RsQ2QZBchIASaLQEdInbENzgUX2rnhsEUGIbZmE9GcjpnrdfkrKfv6ElgqD/GXAuJNWztQq/gwXiRQXJq49ITIuJme37JwISAELCBgA4RGzGHBmLKry1SMJnDMJsKOJGcyombiDg41B+n3HSSLTWTF1p7Yy7pyZY60hr1z0ZEbMORll2EgBBotgR0iNhEYJiZNrXzw2pBzjOYUP82FGTsJrWeUjQXz2AGa/skk1orbK7IExdgSUynvsxGXSRFxM32/JKBCQEhYAMBXSI2h5kx1iFiHE2YQ82YqKcUrWoxj3wsyenk1oqaK0ScjyXRIiK24eDJLkJACNwbBHSIuP7UhELiaDIz2Fx1u3MG2bkFFNAGo8nr+m3Nlt1YaluYytSGpCbujTNLZiEEhIDNBHSI2BHP4FD8yWZ3amaNu+mq3tVoDiXQVHULR82xlOZa2G2xvqGj6veyWGfzUZMdhYAQuKcI6BAxuPgGM9j3xvI1MOIbaMbXWCHhgoJ8CitvaXZ0MWKsfvRaNpb0zJqpiarytRO7SW3k7XWSI76nzkmZjBC47wjoEjGV0qxZ+VB1swaU5p7AknGCypvqrkN1NOLp3wt/dXtdaS6W3ZZqGddXm2zLERER20JJ9hECQqC5EtAnYhwxmUMrStW050OonwdjNjlqty+nZ+bf9Dblioi6DVTd0uziSeDgitri5DrTFjfHJyJurqeXjEsICAFbCOgUsXpWT+XzIQpOkJ4JvQLregBQfUOoelZFKdnpaZT2qnjoT+3nVtgyAbWPiNhWUrKfEBACzZGAfhFrLg4kyF894F1tpeRakuu/tbn27I1mQgNVdUXFJo/BbI6nh4xJCAiB20GgSSJWA6xOM1BAdnoqNj/fvbqmWB4MfzsOtLyHEBACzZdAk0Wsydhkxmw20YZSCnKzOXH8RP3fRVfjq5IKyM2wyFclNd/zQ0YmBITAbSBgFxFr43Q04uvfC9+qB8I39OWhuSfIrKuyQsekJUesA5o0EQJCoNkQsJ+Iq6akIt6HvWhrcsHo1AbHqiRwaSkFJfkU5uaR/e1NvlxUBxoRsQ5o0kQICIFmQ8D+Ir4DUxMR3wHo8pZCQAjYjYCI2G4opSMhIASEgD4CImJ93KSVEBACQsBuBETEdkMpHQkBISAE9BEQEevjJq2EgBAQAnYjICK2G0rpSAgIASGgj4CIWB83aSUEhIAQsBsBEbHdUEpHQkAICAF9BETE+rhJKyEgBISA3QiIiO2GUjoSAkJACOgjICLWx01aCQEhIATsRkBEbDeU0pEQEAJCQB8BEbE+btJKCAgBIWA3AiJiu6GUjoSAEBAC+giIiPVxk1ZCQAgIAbsREBHbDaV0JASEgBDQR0BErI+btBICQkAI2I2AiNhuKKUjISAEhIA+AiJifdyklRAQAkLAbgRExHZDKR0JASEgBPQREBHr4yathIAQEAJ2IyAithtK6UgICAEhoI+AiFgfN2klBISAELAbARGx3VBKR0JACAgBfQRumYh9fHzw9/evMaozZ85w+PBhfSO9SatLly7ZvU/pUAgIASFwuwjYTcQODg6UlZVVj7tfv3506tSJH374gX/961+4u7tz9epVdu/eXb2PwWCgvLy8yXMVETcZoXQgBITAHSRgFxE/+uijqAj4yJEj5OTkaNN5+umnUXL+29/+pv08YMAA2rVrx9atWzUxm0wm+vTpw7lz58jMzGwSAhFxk/BJYyEgBO4wgSaLuHv37vTs2bN6Grm5uRw9epShQ4eSl5fH3r17td/5+fnh6+vLvn378PDwwNPTs7rNyZMnmyRjEfEdPovk7YWAEGgSgSaJuFu3bvTq1Ysff/yRAwcO4O3trUlWRbw/+9nPsBasSlOodEXV71TKQuWLVVSs0hYnTpwgKytL12RExLqwSSMhIASaCQHdIlaiDQ0NpWXLlqSnp3PhwgVtSirl8Pjjj+Pk5MT+/furX1f7DRs2TBP0V199pf1Tm6urqxY9q/zy9u3ba+SZbWUkIraVlOwnBIRAcySgW8RqMh07diQwMFBbkLNehFO5YfWvqKioxpzV4pyzszOFhYXVr1ct6v3jH//g/PnzuhiJiHVhk0ZCQAg0EwJNErGag9lspkuXLhw7dqw6yrV1blUi//bbb7XUht5NRKyXnLQTAkKgORBosohVfjc4OJgHHniAXbt2ceXKlep5qai4Q4cO2s9q4a64uLj6dyo6fuqpp7QIWUXTly9f1s1DRKwbnTQUAkKgGRDQJWJVrvbggw/y0EMP4ejoWD2NHTt2UFBQoP2sStWeeOIJlHDV9tNPP2nlbWfPntV+VuJWJW5KxGorKSnRUhzqX1X+2FY+ImJbScl+QkAINEcCukQ8evRobS4qwlXizM/P1/59//332ustWrTQJFu1MKdu2lDyVtJOSUmpzhG7uLhowjYajZrUW7durbXfvHlzo1iJiBuFS3YWAkKgmRHQLWIV+aoIuK6tbdu2DBo0SKsNViVsauvcuTM///nPtaj466+/rrOdiqBV1YWIuJmdJTIcISAEbimBWypiVRes6oNFxLf0GErnQkAI3OUEdIv43//+t5YPVqkJtdBWld+tSk0MHz5cS00oEZeWltKjRw8tNfH3v/+9uqxNpSZUWkLlm9Win5ubm9ZGIuK7/KyS4QsBIdAoArpErKSq5Kn+1bdYp6olVCpCVU6oTd1RZ7FYqmuFay/WqRs6lMxVnlmVwjVmkxxxY2jJvkJACDQ3ArpEbD2Jm5WvKUm3b99e2/3ixYtaZFy1WZevqedRqMU+vZuIWC85aScEhEBzINBkEcsNHc3hMMoYhIAQuJsJNEnEN7vFWUW86mFA1pt6TT2D4tq1a9Uvyy3Od/PpI2MXAkLAHgR0i7i+h/4oOasnqtX10B/1cB9VY6xu2Dh+/Lg2fnnojz0Oo/QhBITA3UxAt4jVpGs/BvORRx7RnjuhKirUYlxdj8Gs+l3tx2AqMavnGOvZJEesh5q0EQJCoLkQaJKI1STqejC8qnoICQmp88Hwn3/+ufYVSl5eXtUMVITc2EoJa4Ai4uZyOsk4hIAQ0EOgySJWb1r1VUkZGRnVz5Jo6KuSVDVFQEAA2dnZjX62RO2Jioj1HHppIwSEQHMhYBcRq8no+fJQlWdW9cVN3UTETSUo7YWAELiTBOwm4tqTUF8m6u/vX+PlM2fOaF+PZO9NRGxvotKfEBACt5PALRPx7ZyEiPh20pb3EgJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUATcYvIEY1sJrsLgXuHwJgPPe6dychM7koCIuK78rDJoO1JQERsT5rSlx4CImI91KTNPUVARHxPHc67cjIi4rvysMmg7UlARGxPmtKXHgIiYj3U9LRp0QoPZ8i5VqSntbS5CQFXt7Y4FeZx6Sd9mPSJ2EDLTi60pJir3xRTru+tbWpleKQrvk65HD1WbNP+t34nZx7qBN9/U994DLh2MmhcZLONgP1F3DqAuHGDyNwUz6ortg2iOe/V7rFIdg64wvTlCaTp/EMHB4JGLCCh9Wr8PzlESXOe8N02ttahbIp4gl1L3uA9nedbY0Rs6NSNJyOfZNATD+JQUk5RCbi2M/BdahqJcWmczLM3wI6EJs4gzOkg745M4kypvftvfH8PjZ3My2NP8l54Gt/VNZ62/kzf1I+T4R+w8+vG938/trCviDUJh0FaPFHH6/mrcPJm2qhwInw8aW8o5WLeaZYnLeK9s2V49Awnfmh/zO6tofgSp46vJ3zrAVxDFpDUaTt9/7KLS5VHycl7Gl+McmDu4iV8pluQDR9ypw4DifYuYnnaIXIa3r2ePUTEutE11PA2irhl/1Bmze/Kd0uT2LIxh6tVY3NsS+/IkTz/HwZ2Rqxk5+G64mMDHcY+y9Qofzq6FpOz4a98EHOM7xuYn2vYRH4bdpLtJUEEHkjg3TWXGyKC4fEgpi4Mwa8zXP3nQVZOT+ZkQYPNbNvBsSsTtoWSPzcZ15ggvpu+mr1WFx9D/1HMfiGHLYcDmPp4Gm9GHuPHGj270zt6PM9PNOF6NY8v4j5mzca8W/qJwraJ3dm97CdiWyQMBIQuYHP3XGK2biat0AGPTiY4u49dxQNZGzERtyMJRFvOUeJiwtw6j3VHz+FzB0Vsn8MjIrYPxzp6uV0i7tSPWWv7cD7iA7bUKVp4KGwiL0cVs2bkRo7WFt8jTzJ3Uz++j11H4nkPnl8cAnF/5P2NhfWjcezKLzaFUj53GVtKgvjtMhPbx9TRt3UPjh78YttU/Pav44M15fSdP54nzm/kf24Qor4jokT7WuQFlm7sxuxhXxI3I4OWw0IZPgyylu7E8nVbnkt8FqIP0mGxL/ufWscRq6jZdexk/jsKtkVs40znoUyNcWfPmGUk3+eRsz4RuwUwqeM5Vh2vvBS28Oa1SeG4pS2qPxLWjrsDzz3/f8T+tIS+m2p9RO8wjn2/fpR1dXzE9GtAxLs6h5MyzptP18Tw5jfXTzCnTiNJGDWcIHd3nDnL4tWrcXt2Jq7JrzDjeBm0CGDpy+O4uiaGqG/KoPWjzB4Rzos+D+NafolPt79BZHk4GcF5/PL/VnMIB/weC2ehitqdyzh3fh8xW1fzWV3BfwsT40dOI9rPR+srp9iN9heWVKQmWph4bng4r/l5054rWCwJTN+ZgVtQLCl++xm6YhunACfPcPaNc+PNd1bj9Owc5ni3pYuzI8WXj7HleB7dugfg5+7A1fP7mLs+gc+uqUb9WfpiOM+oTxWFZ/k0dQWRh85RgolJE35HtJc7blzGkrWa6VsPkENbxo+x6lu1SVlCZJaJ+IhpkBRRwQoTr02LxWx5hTGHrCfsgM9j4SwODsDs7sDFC8lM/vN6Djn789qoifzSqy2uxedYt30JUUfzwMmf2BfCea5jO9obrvH59hgmfBfC5lED8XNRx+ka587vImrTenap+dTY2vJ06DRie3vTxVDGySMrGJralrUR4+hWXIariwMleRks3LqEFep42rg1nJow0DPuJUZ+/RELl+bRYZg/xqP/5GjluWZ43J++nGT/YQPmpbMIOfwnbT/rrcOMWbw27EteH7tHi4I7R79EVM80ol84eD2yrjXeh6ZMZfbjacRpEjXQLXYWz139mIULL9Q7MyXK15c9SOKglewvAMOTY5m/2JlP+q3GYoe0Rsuxk4l6PI01jCTs2J94d4MHU3c8SVkq+Lru4fXIk3SNncXww3/lwpQQvlfpiWoULgxaM4eQox/wP/PV50t3Qja+xBP73+ethXbP6dh49JvHbvpE7PQor42biIclnhnqj0v7I5/JM6cTCD94+qY5UI+AOaQMN5GWupqFlkNkVSVMWzxK3ItzeK54H/N3JrLubF51Pw2J+DP3ISwN9eGzpBVssXKEU89IMoaWEbVmPRYcKC5wY+70+kTcivHPxxLrso+IpL2cwg2n4q841SmyWsRZnSaSMimAzG1LWPSNA0NCZzLXOZERHyZr4rTe/EJiSfLLY/7W9ewqNzE5dBrjC1doIvYImkeS+QrzN60mzXk4y8YEkLn+VSLLx7Fvkonlixex6hr4qD467GTA2tO8+Jt5mI/EEJnlgDl4JvHdr7BoUwJbLpuYPW4mQaffZmDyacANv06tuHi5jG69p5EwoIioxfFsKXHAo0MXbVGrpGMYCeP6k7n+FSJPm3jtN/MYcOQNpmeV4eEXzrIBZcxfsoSSEX/gtZJ4Bm79ihKnIax9OYTMP8fw5nfWF7tKJttXsOj0FVxd4NQ3RTwzYQHRbGZ68iHoPo1lA4qIUeMwqJxuCKfWx6P+9tzKc8nxVMepiKg1m8l09mb2qGmYT7/N0OSa55JPv3kkDSjiva3r2XLZAQ9DHmmF/bX+cjYtYVGeA0HBM4lz28nQDysuZrZsDYrYsQdTdwRxYswH7M1TKYbxzJhSzJbwjWS1C2LGMn8uzF3JhgPFmvhej7rEe2F7uI7JQO/4V5nERv4r8pj2MdwwdjLvRP7Ae09t5WRdgmzTg0mbgjg/fSU5U2Yx2Wk7r8c5M2NtT76YsJr99Xir5QtT+d8Zl3j3qa0V+eROQczdEcDJke+zxQ5RpyFsIq8/eYgPLg1lAht4a2ExoRtfYnQf+Dr2jyz8sJDe8bPo+/dtFEUGcX7MSvZWfTpQaY0dkzHGL+D9jWohT13g5jDVdRv/NSPjvk5P6BOxOrtry7hFFyaNm8ZzZxMITztd71UeWuH32GiiBwwkyL0Ii2U9USkHOKXyvG7+zB46mkndu+CWd4iFyQmsOFuEEvHOAQ9TXG59xjriXL6fye/UnyPWRFwdzQJK9jPrEfHlgWyKGE7WqleJsY6qq/tYj7NacHPbTN+1+yrmZxxJyotPsGX521wJXcxCH0fgGpvXv0XOk//NgKxXGZGm/mKsUxO5zJkWa/W7VoyfsJjZ+W8wMKUVcTMjaZ/yCuFHWzHtV7E8czyGMQdbabLs9flvmPBlGU7qgvBCWxa9E8+WnyrTPcZEfNfuq3kRdBrI2peHk7k8hjfzrZVkYvaUWIYciWDMobY1+q74lDCRkvWvEtN6Jl8MvUL4kgQsPjP5IrSI6UusFy0r52XNRL1N6yE1Wao+I8Ip2foKkRfU72ourtU+Tj7qk4H3zhprAupiP3taLM9UM62cT63UxPVPERVsbNkaFHGPUH6/0MDasCTOaB0a6PzCRGZMMXDFqSXnoxNYu6cyxdCmH7/d0ZWdg6w/khswfxjN6EsreT3qTIWIwybyvzHlrKqx3/XRdp47SxPUmzE5dI19Sft/dOQxOla/XtFP7e2hKdN5/YUzxA1L5rz6pRrPwSByJvyRDYdtodHAPirFstiFDdEwaXFLtkzPYVBCHy5sKOdx74PExT/I1GUm9kT8QMh8AxuqmQGO3Zi0dzwtYxewLFGjQLfYl5jdOYWXp/xTRKz7FmfdMlYH2wEP71DiR42mfVat6MepC+OHzySuex5RSxaR2X8BSZ6HmJC0n+qAt9NoPg4uu+liXaNEXD6alF978/Hit1lh9ZH4eh/r6fL84usRoppCi/4kvDyOi+tfZX5hF3yc1YtlXPqhFXOmRuKWEkH4UfUR2UrEm4qIm/l7fule84Q/d2ShFnkGjVrAYsNq+m53Y+3MQXy6/A1WXOlSU5bGcaS86M3Kd95mVQlUicv/L7soMQ4kbtRonunohlN5GTjnsVyJ+LI300aG86K3ifaGMkpwIHO7SjO41RKx1cUqO4CEmeO4uOlVtvgtIN6QwMCtGVayV6mmWkzUtDqo8YXRq8YUr/HpxgjCzzYsYteA35HR+0sGfrjt+gKpdhFVF6kqpnWLGI1NF5bHLWKdvURcKR8lYk1uSiGP9GPG2hF0vXqIpWO2Xl8M00TcjZ2DVlvlRhsZEbftw/S1PTmiRb4VsqoScXmbHkzdFMQZ9ZHfKmCoQn2rI2KVThi05j/pvfEjtmPC2GMAz3X+nLfmljNhRxBnIvZw1fUHysJ+ScixilRO9SYRcb1XOf0RcVWXbqFsmuTD8iWVkamKjJ8dTknKCtY1WE7kQMCIBWzusJ2BHybXrErQojkluVdY7hmrq2riBhHThdjfzMPn8wgmfFlUM0fcpIg4hvdqRZwqnxqSFcPQtNxaEXEec6bNqyPXWgFUi+jGtGLR527Edrcw9C+KS0MinkeK9178/3KAZyb8gTnlq5mwdR+nUAugw8lcFcMqz3nsM+cyfU0Cn11xY/aUBQw50oCIj6OV3S1z3smnHYbjlKxSGda515tFxCFYaqUxtAnWsbhW+zjVKWLFYNo8q08St1HENVIT6uN+H6YmBFMW9xF7vZ9l6rAcVoZXVCZoi1kxxSwNS7ZKTUBVjvjNsRUpi/pzxBW54OevfsxblbngDmGhDHL6kg0bK3LDHaZMZUZ17rjm37aWI054kMR+tyZHXHERCmJyZDmJ0T8wfMdEelOMdlY4OVP+t5W8Hu/M8/PbsT9iT61yu+s54jfn51AuOeLqg9c0EWsR8TjaW5YQqeWKG9ocCHgslF4lp7HkXQEXtTg2kQHfLaFvCkzya8Wps6fJKW6FT+9xLO7fiveWx7CzdwPla5U54l1JNeV/o4gdeHrMH1jsdoCIpO1k4U/cpOHkaIt1bkyaEEu08z4ikreTVexGO3LJ6jCtVo7Yn8xtKxrMEVfkM8tYmbSaVRfKMA/9HXEtErQcsZb71fLHm/nschGu7m5cVfPW8HkT+5s5jHeBzJRXKxfGGiPixcwpTyA86RCnUBFtLRGvX03aZTcmT1KpiYZEXFYR3f46FJ/iA4QvXsGun9DKDOP8vmX+J8mcUheOF/zJ2r6C+afzcHJvxdWzRQz5VSxzSWRu8gGyilvh4VKG5ZtcShol4l34hMzkxeJEwtO+0iL/pP5XWKRyxHlltHMpI+tyAGutUx23IiLGWct7jjz/EXEL8+gaPZHAw39lVaIqJXOm29zxhHzzV5atKdb2Cz2WcMNiHSqq3taP76PXkXjag+eX1VM18YiqjvBg55h1HKnMrXYIG0GI0yHWVooYrYRsJD9GvM+WY7X+5qyrJj4sp+9C+1ZNWL+b6wuT+f3YM7xbeXFBjT2hG+ljVtabw76hamK+O3tGStWEfhG39id23DhcD8TbKGF1CN0YEqIqCbzxcW+Nc/llMk/tY37Sena5DGHpiDAGdHSjvQGuXD7Hp6kJRH3ZcPnars4TSRn36I1VE7VzxNoQ+hM3ZiLjO7vjXH6Ni5e/YuH6eFapiLZ1xUr/ZK+HKyoLUuMZfTms7qoJlzLOZd+kagK1wh9OdO9H6aYqHYovYbGsYMLOr2pUTXRxVnM9RNSfl7ClMiWipRoG5BGpLbKpQdsq4l2UdApl2ajRDGmr+JZypTCD+aviWVWsLprTmNy5HW4G9XpeRVXI0do54lp5dNyY9Ks/MDv/bQYmVSye+QXNY7OKrpcoMTvgFxDOwuD+mF0q57J8CVsM1iyvcS57PRPW7uJUo0R8gCETYplbnkDIJwe4ZFVtorhdPLWaEVsdiL/lIgZNMmv7cWHun67ng2s58KGw8cyO/JFPxmy9sXyN63XEHq7FfF1nHbES/gxCDn/Eux9eD2xa9uhGV3Vn3eHrpW5KaFFa+dg/b1iPqa4j9jZwdX8aayKSsSlOaiiOqvH7jjyXOINBTjmcOV+VrTZg7ONB2eql1dH8jV260zt2PBN+0YVWV3M5EvcxK6WOGH0irpRwuwNVVRONOoKy811BoBWuTuDWeTTLRnXh4z+/fU/cKVkX+gYX6yobuQ4bxaz5vlzdsI1P4o9dv6us6oaO0HK2R6xj7zGdNzyrFMje8fQsKax1E0Rdozbg6prLmsoytdt9SlVUh/zIJ9EZNS8Erj34RUwbtqlaajuUy93ued2p99MnYrcAxnc8x7qqOuI7NXp531tHwDiSpBfH41d86noN8K17tzvas60irsiP+hMWFUzfPs6UXSqgiJa4ucKF1DS2xR/kjC0ZugZma3A02MSjvFSn8G3q/eY7uQ57kidKDpK8p/bzJJzpOeVJHJKTOVLHYqId3vqe7EKfiO9JFDKp+5VAY0RczcjRGdd2LhhKCrmad2sf+nO/Hpf7ad4i4vvpaMtc6ySgS8TCUgjYkYCI2I4wpau7k4CI+O48bvfSqEXE99LRlLnoIiAi1oVNGtmRgIjYjjClq7uTgIj47jxu99Ko/x/HmHxRljJAeAAAAABJRU5ErkJggg=="},80759:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/rucio-server-debug-98c2ec8a56860d6718e4da5bf97bc709.jpeg"},46399:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/rucio-tasks-a9f11e37004c47a3ee27c6549b968aee.jpg"},28453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(96540);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1f6484bf.cbad7e5f.js b/assets/js/1f6484bf.cbad7e5f.js new file mode 100644 index 0000000000..c8339d64ab --- /dev/null +++ b/assets/js/1f6484bf.cbad7e5f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5680],{47369:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"developer/setting_up_vscode_dev_env","title":"Setting up a Rucio Developer environment using Visual Studio Code","description":"Local Setup vs Remote Setup","source":"@site/../docs/developer/setting_up_vscode_dev_env.md","sourceDirName":"developer","slug":"/developer/setting_up_vscode_dev_env","permalink":"/documentation/developer/setting_up_vscode_dev_env","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/developer/setting_up_vscode_dev_env.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"setting_up_vscode_dev_env","title":"Setting up a Rucio Developer environment using Visual Studio Code"},"sidebar":"docs","previous":{"title":"Setting up a Rucio Developer environment using IntelliJ Ultimate","permalink":"/documentation/developer/setting_up_intellij_dev_env"},"next":{"title":"Contributing Guide","permalink":"/documentation/contributing"}}');var o=i(74848),t=i(28453);const r={id:"setting_up_vscode_dev_env",title:"Setting up a Rucio Developer environment using Visual Studio Code"},c=void 0,d={},l=[{value:"Local Setup vs Remote Setup",id:"local-setup-vs-remote-setup",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"VSCode",id:"vscode",level:3},{value:"Remote Only: Additional Setup VSCode",id:"remote-only-additional-setup-vscode",level:3},{value:"VSCode Extensions",id:"vscode-extensions",level:3},{value:"Docker and Docker Compose",id:"docker-and-docker-compose",level:3},{value:"If you get a docker-compose: command not found error",id:"if-you-get-a-docker-compose-command-not-found-error",level:4},{value:"SSL Certificates",id:"ssl-certificates",level:3},{value:"Setting up Rucio and Configuring VSCode",id:"setting-up-rucio-and-configuring-vscode",level:2},{value:"VSCode Tasks",id:"vscode-tasks",level:2},{value:"Starting Rucio",id:"starting-rucio",level:3},{value:"Stopping Rucio",id:"stopping-rucio",level:3},{value:"Debugging Overview",id:"debugging-overview",level:2},{value:"Debugging Rucio Server",id:"debugging-rucio-server",level:3},{value:"Debugging Rucio WebUI",id:"debugging-rucio-webui",level:3},{value:"Debugging Rucio CLI Clients ( rucio-admin and rucio)",id:"debugging-rucio-cli-clients--rucio-admin-and-rucio",level:3},{value:"Debug rucio cli client",id:"debug-rucio-cli-client",level:4},{value:"Debug rucio-admin client",id:"debug-rucio-admin-client",level:4},{value:"Debugging Rucio Tests",id:"debugging-rucio-tests",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"local-setup-vs-remote-setup",children:"Local Setup vs Remote Setup"}),"\n",(0,o.jsx)(n.p,{children:"It is possible to run the containers for rucio development locally or on a remote VM."}),"\n",(0,o.jsxs)(n.p,{children:["For local development machines with limited resources ",(0,o.jsx)(n.code,{children:"(<16 GB RAM, < 4 Cores)"}),", it is recommended to run the containers on a remote VM. This will allow you to use your local machine for other tasks while the containers are running on the remote VM."]}),"\n",(0,o.jsxs)(n.p,{children:["Local development has been tested only on Linux hosts.\nRemote development has been tested on Linux(for the remote VM) and Linux/MacOS(for the local instance of vscode).\nThe additional steps required for setting up a remote development environment are described in the sections begininng with ",(0,o.jsx)(n.code,{children:"Remote Only: "}),". These sections can be ignored if you are setting up a local development environment."]}),"\n",(0,o.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,o.jsx)(n.h3,{id:"vscode",children:"VSCode"}),"\n",(0,o.jsxs)(n.p,{children:["Install ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/Download",children:"Visual Studio Code"})]}),"\n",(0,o.jsx)(n.h3,{id:"remote-only-additional-setup-vscode",children:"Remote Only: Additional Setup VSCode"}),"\n",(0,o.jsxs)(n.p,{children:["For development on a remote VM, you will need to install the ",(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack",children:"Remote Development Extension Pack"})]}),"\n",(0,o.jsxs)(n.p,{children:["You should setup SSH access to your remote VM. For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/ssh",children:"Connecting to a remote host"})]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Remote-SSH: Open SSH Configuration File"}),"\n",(0,o.jsx)(n.img,{alt:"Open SSH Configuration File",src:i(67403).A+"",width:"609",height:"270"})]}),"\n",(0,o.jsxs)(n.p,{children:["You will be asked to create a new SSH configuration file or select an existing one. If you have an existing SSH configuration file, select it. If you do not have an existing SSH configuration file, select ",(0,o.jsx)(n.code,{children:"Create New File"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Update the SSH configuration file:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host \n HostName \n User \n"})}),"\n",(0,o.jsxs)(n.p,{children:["Additionally, you can use the ",(0,o.jsx)(n.code,{children:"IdentityFile"})," option to specify the SSH key to use for authentication. For example:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host \n HostName \n User \n IdentityFile ~/.ssh/\n"})}),"\n",(0,o.jsx)(n.p,{children:"If your remote VM is behind a firewall, you will need to setup a proxy. For example, at CERN, we can use lxplus as a ssh proxy to connect to the remote VMs, which are not accessible outside the CERN network. The following is an example of an SSH configuration file that uses lxplus as a proxy:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"Host lxplus\n HostName lxplus.cern.ch\n User \n\nHost \n HostName \n User \n ProxyCommand ssh -q -W %h:%p lxplus\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/ssh",children:"Connecting to a remote host"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Test connection to Remote VM"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Remote-SSH: Connect to Host..."})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Select the remote VM from the list of hosts"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Depending on your SSH Configuration, you may be prompted for the password/s in the following order:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"remote user on the proxy host"}),"\n",(0,o.jsx)(n.li,{children:"ssh key password or the password of the remote VMs user."}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The bottom right corner of VS Code will show the status of the connection. If the connection is successful, you will see ",(0,o.jsx)(n.code,{children:"SSH: "})," in the bottom right corner:"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"Successful Connection",src:i(76587).A+"",width:"354",height:"108"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["For troubleshooting and Tips/Tricks, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/remote/troubleshooting",children:"Troubleshooting"})]}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"NOTE for remote development"}),": From hereon out, all the instructions should be run in the VSCode instance connected to your remote VM. ( i.e. the VSCode instance that shows ",(0,o.jsx)(n.code,{children:"SSH: "})," in the bottom right corner)\nYou can use the terminal in the VSCode instance to run commands on the remote VM directly. To do so, open the terminal in VSCode instance connected to your remote VM by clicking on ",(0,o.jsx)(n.code,{children:"Terminal"})," in the menu bar and then clicking on ",(0,o.jsx)(n.code,{children:"New Terminal"}),"."]}),"\n",(0,o.jsx)(n.h3,{id:"vscode-extensions",children:"VSCode Extensions"}),"\n",(0,o.jsx)(n.p,{children:"Install the following extensions:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-python.python",children:"Python"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance",children:"Pylance"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker",children:"Docker"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers",children:"Remote - Containers"})}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["VSCode comes with a plethora of extensions that can significantly improve your development experience. For more information, see ",(0,o.jsx)(n.a,{href:"https://code.visualstudio.com/docs/editor/extension-gallery",children:"Extensions"})]}),"\n",(0,o.jsx)(n.h3,{id:"docker-and-docker-compose",children:"Docker and Docker Compose"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Install ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})]}),"\n",(0,o.jsxs)(n.li,{children:["Install ",(0,o.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"})]}),"\n"]}),"\n",(0,o.jsxs)(n.h4,{id:"if-you-get-a-docker-compose-command-not-found-error",children:["If you get a ",(0,o.jsx)(n.code,{children:"docker-compose: command not found"})," error"]}),"\n",(0,o.jsxs)(n.p,{children:["Docker has deprecated the ",(0,o.jsx)(n.code,{children:"docker-compose"})," command in favour of ",(0,o.jsx)(n.code,{children:"docker compose"}),".\nTo turn on ",(0,o.jsx)(n.code,{children:"docker compose"})," support in ",(0,o.jsx)(n.code,{children:"docker"})," command, please make sure you have installed the ",(0,o.jsx)(n.code,{children:"docker-compose-plugin"})," package from the ",(0,o.jsx)(n.code,{children:"docker-ce-stable"})," repository."]}),"\n",(0,o.jsxs)(n.p,{children:["The full command to install ",(0,o.jsx)(n.code,{children:"docker"})," and ",(0,o.jsx)(n.code,{children:"docker compose"})," on RPM-based installations is:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-bash",children:"yum install docker-ce docker-compose-plugin\n"})}),"\n",(0,o.jsx)(n.h3,{id:"ssl-certificates",children:"SSL Certificates"}),"\n",(0,o.jsxs)(n.p,{children:["If you would like to debug the rucio webui and x509 authentication capabilities of the rucio server, you will need to obtain SSL certificates for your development environment. For remote VMs, you can request them from your IT department or you can use letsencrypt to generate a certificate. For local development machines, you can use ",(0,o.jsx)(n.a,{href:"https://github.com/FiloSottile/mkcert",children:"mkcert"})," to generate a certificate."]}),"\n",(0,o.jsxs)(n.p,{children:["Whatever route you go, you should have a ",(0,o.jsx)(n.code,{children:"hostcert.pem"})," and a ",(0,o.jsx)(n.code,{children:"hostkey.pem"})," file accessible for your development environment."]}),"\n",(0,o.jsx)(n.h2,{id:"setting-up-rucio-and-configuring-vscode",children:"Setting up Rucio and Configuring VSCode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Clone the rucio repository"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"gh repo clone rucio/rucio\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Clone the vscode configuration repository"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"gh repo clone maany/rucio-vscode-dev-env\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Move the vscode repo inside the rucio repo"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv rucio-vscode-dev-env rucio/.vscode\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Copy the SSL certificates to the ",(0,o.jsx)(n.code,{children:"rucio/.vscode/certs"})," directory"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open VSCode. If you are using a remote VM, open the VSCode instance connected to your remote VM."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Go to ",(0,o.jsx)(n.code,{children:"File"})," -> ",(0,o.jsx)(n.code,{children:"Open Folder"})," and select the ",(0,o.jsx)(n.code,{children:"rucio"})," folder"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Edit the rucio/.vscode/docker-compose.yml and change the ",(0,o.jsx)(n.code,{children:"RUCIO_HOST"})," environment variable for the rucio-dev container to ",(0,o.jsx)(n.code,{children:"http://localhost"})," if you are using a local development environment or to the fqdn and port of your remote VM if you are using a remote development environment.\n",(0,o.jsx)(n.img,{alt:"RUCIO_HOST",src:i(75253).A+"",width:"1092",height:"520"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Add the default url for webui in ",(0,o.jsx)(n.code,{children:"rucio.cfg.template"}),", which is required to handle Cross Origin Requests (CORS) in the webui. Add the following line to the ",(0,o.jsx)(n.code,{children:"[webui]"})," section of ",(0,o.jsx)(n.code,{children:"rucio.cfg.template"}),":\n",(0,o.jsx)(n.code,{children:" urls = "})]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If your server is running on a remote VM, but webui will be running locally, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If both the server and webui are running locally, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),". In this case, you can set the ",(0,o.jsx)(n.code,{children:"urls"})," to ",(0,o.jsx)(n.code,{children:"http://localhost:3000"}),"."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["If both the server and webui are running on the same remote VM, then the requests originating from webui to the server will have the origin ",(0,o.jsx)(n.code,{children:"http://:3000"}),". In this case, you can set the ",(0,o.jsx)(n.code,{children:"urls"})," to ",(0,o.jsx)(n.code,{children:"http://:3000"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"vscode-tasks",children:"VSCode Tasks"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsx)(n.li,{children:"You should see a list of pre-configured tasks"}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"tasks",src:i(46399).A+"",width:"599",height:"334"})}),"\n",(0,o.jsx)(n.p,{children:"These tasks are helpful utilities for your to quickly start/stop rucio containers and to setup different types of debuggers ( server, webui, pytest, clients, ...)."}),"\n",(0,o.jsx)(n.h3,{id:"starting-rucio",children:"Starting Rucio"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"start-rucio"})]}),"\n",(0,o.jsx)(n.li,{children:"This will start and initialize the rucio development environment. The first time you run this task, it will take a while to fetch and build the docker images. Subsequent runs will be much faster."}),"\n"]}),"\n",(0,o.jsx)("video",{width:"100%",controls:!0,children:(0,o.jsx)("source",{src:"/documentation/img/vscode/start_rucio_task.mp4"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["After the command has finished, you can run ",(0,o.jsx)(n.code,{children:"docker ps -a"})," to check if all the containers are up and running. You should see something like this:\n",(0,o.jsx)(n.img,{alt:"docker ps -a",src:i(49962).A+"",width:"1515",height:"453"})]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"stopping-rucio",children:"Stopping Rucio"}),"\n",(0,o.jsxs)(n.p,{children:["To take down all the containers, run the ",(0,o.jsx)(n.code,{children:"stop-rucio"})," task. This is equivalent to a ",(0,o.jsx)(n.code,{children:"docker-compose down"})," command."]}),"\n",(0,o.jsx)(n.h2,{id:"debugging-overview",children:"Debugging Overview"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio server, webui, clients, etc."]}),"\n",(0,o.jsx)(n.p,{children:"The debugging process for Rucio in VSCode is broken down into 3 steps:"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Start the process inside the ",(0,o.jsx)(n.code,{children:"rucio-dev"})," container that you want to debug"]}),"\n",(0,o.jsx)(n.li,{children:"Attach the debugger to the process"}),"\n",(0,o.jsx)(n.li,{children:"Insert breakpoints in the code and start debugging"}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are done debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-server",children:"Debugging Rucio Server"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio server."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server:debug"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Attach the debugger to the rucio server by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Server: Debug"})," from the dropdown menu."]}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"attach to rucio-server",src:i(80759).A+"",width:"393",height:"514"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio server."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"You can now set breakpoints in the rucio server code and debug the server."}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["After you have finished debugging, you can detach the debugger from the rucio server by clicking on the ",(0,o.jsx)(n.code,{children:"Stop"})," button in the debug toolbar."]}),"\n",(0,o.jsxs)(n.p,{children:["**NOTE: ** After detaching the debugger, run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n",(0,o.jsx)("video",{width:"100%",controls:!0,children:(0,o.jsx)("source",{src:"/documentation/img/vscode/rucio-vscode-server-debug.mp4"})}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-webui",children:"Debugging Rucio WebUI"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio webui."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio webui, you will need to start the rucio server in non-debug mode and the rucio webui in debug mode."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-ui:debug"})]}),"\n",(0,o.jsxs)(n.li,{children:["Attach the debugger to the rucio webui by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"UI: Debug"})," from the dropdown menu."]}),"\n",(0,o.jsxs)(n.li,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio webui."]}),"\n"]}),"\n",(0,o.jsxs)(n.h3,{id:"debugging-rucio-cli-clients--rucio-admin-and-rucio",children:["Debugging Rucio CLI Clients ( ",(0,o.jsx)(n.code,{children:"rucio-admin"})," and ",(0,o.jsx)(n.code,{children:"rucio"}),")"]}),"\n",(0,o.jsx)(n.h4,{id:"debug-rucio-cli-client",children:"Debug rucio cli client"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio cli clients."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio cli clients, you will need to start the rucio server in non-debug mode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Then, you need to start the ",(0,o.jsx)(n.code,{children:"rucio-cli:pre-debug"})," task to inject the debug configuration into the rucio cli clients."]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-cli:pre-debug"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Start the ",(0,o.jsx)(n.code,{children:"Rucio:CLI Debug"})," launch configuration by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Rucio:CLI Debug"})," from the dropdown menu."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio cli clients."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["After that, you should open a shell inside the ",(0,o.jsx)(n.code,{children:"rucio-dev"})," container"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"docker exec -it rucio-dev bash\n"})}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Insert breakpoints in the rucio cli clients code."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Run a rucio cli command to trigger the breakpoint."}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are finished debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the debug process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"rucio-cli:post-debug"})," task to remove the debug configuration from the rucio cli clients."]}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"debug-rucio-admin-client",children:"Debug rucio-admin client"}),"\n",(0,o.jsxs)(n.p,{children:["The instructions are the same as for the ",(0,o.jsx)(n.code,{children:"rucio"})," client, except that you need to start the ",(0,o.jsx)(n.code,{children:"rucio-admin:pre-debug"})," task to inject the debug configuration into the rucio-admin client."]}),"\n",(0,o.jsxs)(n.p,{children:["After debugging, you should run the ",(0,o.jsx)(n.code,{children:"rucio-admin:post-debug"})," task to remove the debug configuration from the rucio-admin client."]}),"\n",(0,o.jsx)(n.h3,{id:"debugging-rucio-tests",children:"Debugging Rucio Tests"}),"\n",(0,o.jsxs)(n.p,{children:["After you have run the ",(0,o.jsx)(n.code,{children:"start-rucio"})," task, you can start debugging the rucio tests."]}),"\n",(0,o.jsx)(n.p,{children:"To debug the rucio tests, you will need to start the rucio server in non-debug mode"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Open the Command Palette (Ctrl+Shift+P)"}),"\n",(0,o.jsxs)(n.li,{children:["Run the command ",(0,o.jsx)(n.code,{children:"Tasks: Run Task"})]}),"\n",(0,o.jsxs)(n.li,{children:["Select ",(0,o.jsx)(n.code,{children:"rucio-server"})," to start a rucio-server in non-debug mode"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Then, you should open the file containing the test you want to debug in VSCode."}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsx)(n.p,{children:"Insert breakpoints in the test code."}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Start the ",(0,o.jsx)(n.code,{children:"rucio-pytest:debug"})," to start the test in debug mode"]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Attach the debugger to the test by clicking on the ",(0,o.jsx)(n.code,{children:"Debug"})," icon in the left sidebar and selecting ",(0,o.jsx)(n.code,{children:"Pytest: Debug"})," from the dropdown menu."]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["Press ",(0,o.jsx)(n.code,{children:"F5"})," to start debugging the rucio tests."]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"After you are finished debugging, you should remember to"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"detach the debugger from the debug process"}),"\n",(0,o.jsxs)(n.li,{children:["run the ",(0,o.jsx)(n.code,{children:"cleanup"})," task to remove all processes inside the container that were used for debugging."]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},75253:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-compose-rucio-host-465a74fa33e82533f549c7342c5942e2.jpg"},49962:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/docker-ps-7e66472c5b3eaab849aed2e0fe06e354.jpg"},67403:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/remote_ssh-b59c7e945ebcc026fee6dd82cfebe0ab.jpg"},76587:(e,n,i)=>{i.d(n,{A:()=>s});const s="data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAAWIAAABsCAYAAABQIbi+AAAAAXNSR0IArs4c6QAAH3dJREFUeF7tnQ1UVWW6gJ/Gw4+KQB3/TopgIKZIJsfRQA3FxFKupU465hrF8ZqOS6Ep5TYTeLth5UWnBmt5/ZkmdFLT/BsHKRlRUQN1Oo4GaP4lioUplAoSf83c9W1+PCDIYXNU1Hev5Vpy2N93vu/Zm2e/5/3evc8DRqPx315eXtzN26VLl+7m4cvYhYAQuM8JPCAivs/PAJm+EBACd5yA/UXsYsTzYS8eNrnQxqkNjo6VcywtpaCkgMLcb8n+9iz5hfabu0TE9mMpPQkBIXD7CdhPxC4mevn74mVsUzGL0gLy8wsppYQSnHDCERejkTaVYi7Iz+ZERia5dhCyiPj2nzjyjkJACNiPgF1E7OJpJsjfhCOl5Gcf50T2TSJeFTF7+dLdy6jtn5uRhuVs02wsIrbfCSE9CQEhcPsJNFnExl7BBHq1gYJsLJZGRLgqgjabqWiaTmpmvu7Zi4h1o5OGQkAINAMCTRKxi2cgg/2NlOZmkGY5i3Vc62g04eX1MEZHFy3yLSzI59vsbHILS62m7YKnOQh/kyP5GbtJ1xkZi4ibwZkkQxACQkA3Af0idvEleLAvbQpOsDv1hJWEXTCZzZhNlblilS4GqtbsCrItpGfmaq9VbC74Bg/Gt00BJ3anckJHlkJErPv4S0MhIASaAQGdInbEMzAUf2MBGbtTsQ5kr6cqcsnIzOBsfoVyHY2e+PfyR/n5hlSEiyfBg/1pk59BcvpZK0nbRkhEbBsn2UsICIHmSUCfiF16ETzYC6fsdJKtc7vVUXI26amZ3Jj1NdIrOBCvOqJfY69QAr1KdEXFIuLmeXLJqISAELCNgC4Ru/QKZrAXN0jTpVcog70cybUkYsmtZwAmM2FmEwXZu0nNtMpDVEqc2q/bMA8RsQ2QZBchIASaLQEdInbENzgUX2rnhsEUGIbZmE9GcjpnrdfkrKfv6ElgqD/GXAuJNWztQq/gwXiRQXJq49ITIuJme37JwISAELCBgA4RGzGHBmLKry1SMJnDMJsKOJGcyombiDg41B+n3HSSLTWTF1p7Yy7pyZY60hr1z0ZEbMORll2EgBBotgR0iNhEYJiZNrXzw2pBzjOYUP82FGTsJrWeUjQXz2AGa/skk1orbK7IExdgSUynvsxGXSRFxM32/JKBCQEhYAMBXSI2h5kx1iFiHE2YQ82YqKcUrWoxj3wsyenk1oqaK0ScjyXRIiK24eDJLkJACNwbBHSIuP7UhELiaDIz2Fx1u3MG2bkFFNAGo8nr+m3Nlt1YaluYytSGpCbujTNLZiEEhIDNBHSI2BHP4FD8yWZ3amaNu+mq3tVoDiXQVHULR82xlOZa2G2xvqGj6veyWGfzUZMdhYAQuKcI6BAxuPgGM9j3xvI1MOIbaMbXWCHhgoJ8CitvaXZ0MWKsfvRaNpb0zJqpiarytRO7SW3k7XWSI76nzkmZjBC47wjoEjGV0qxZ+VB1swaU5p7AknGCypvqrkN1NOLp3wt/dXtdaS6W3ZZqGddXm2zLERER20JJ9hECQqC5EtAnYhwxmUMrStW050OonwdjNjlqty+nZ+bf9Dblioi6DVTd0uziSeDgitri5DrTFjfHJyJurqeXjEsICAFbCOgUsXpWT+XzIQpOkJ4JvQLregBQfUOoelZFKdnpaZT2qnjoT+3nVtgyAbWPiNhWUrKfEBACzZGAfhFrLg4kyF894F1tpeRakuu/tbn27I1mQgNVdUXFJo/BbI6nh4xJCAiB20GgSSJWA6xOM1BAdnoqNj/fvbqmWB4MfzsOtLyHEBACzZdAk0Wsydhkxmw20YZSCnKzOXH8RP3fRVfjq5IKyM2wyFclNd/zQ0YmBITAbSBgFxFr43Q04uvfC9+qB8I39OWhuSfIrKuyQsekJUesA5o0EQJCoNkQsJ+Iq6akIt6HvWhrcsHo1AbHqiRwaSkFJfkU5uaR/e1NvlxUBxoRsQ5o0kQICIFmQ8D+Ir4DUxMR3wHo8pZCQAjYjYCI2G4opSMhIASEgD4CImJ93KSVEBACQsBuBETEdkMpHQkBISAE9BEQEevjJq2EgBAQAnYjICK2G0rpSAgIASGgj4CIWB83aSUEhIAQsBsBEbHdUEpHQkAICAF9BETE+rhJKyEgBISA3QiIiO2GUjoSAkJACOgjICLWx01aCQEhIATsRkBEbDeU0pEQEAJCQB8BEbE+btJKCAgBIWA3AiJiu6GUjoSAEBAC+giIiPVxk1ZCQAgIAbsREBHbDaV0JASEgBDQR0BErI+btBICQkAI2I2AiNhuKKUjISAEhIA+AiJifdyklRAQAkLAbgRExHZDKR0JASEgBPQREBHr4yathIAQEAJ2IyAithtK6UgICAEhoI+AiFgfN2klBISAELAbARGx3VBKR0JACAgBfQRumYh9fHzw9/evMaozZ85w+PBhfSO9SatLly7ZvU/pUAgIASFwuwjYTcQODg6UlZVVj7tfv3506tSJH374gX/961+4u7tz9epVdu/eXb2PwWCgvLy8yXMVETcZoXQgBITAHSRgFxE/+uijqAj4yJEj5OTkaNN5+umnUXL+29/+pv08YMAA2rVrx9atWzUxm0wm+vTpw7lz58jMzGwSAhFxk/BJYyEgBO4wgSaLuHv37vTs2bN6Grm5uRw9epShQ4eSl5fH3r17td/5+fnh6+vLvn378PDwwNPTs7rNyZMnmyRjEfEdPovk7YWAEGgSgSaJuFu3bvTq1Ysff/yRAwcO4O3trUlWRbw/+9nPsBasSlOodEXV71TKQuWLVVSs0hYnTpwgKytL12RExLqwSSMhIASaCQHdIlaiDQ0NpWXLlqSnp3PhwgVtSirl8Pjjj+Pk5MT+/furX1f7DRs2TBP0V199pf1Tm6urqxY9q/zy9u3ba+SZbWUkIraVlOwnBIRAcySgW8RqMh07diQwMFBbkLNehFO5YfWvqKioxpzV4pyzszOFhYXVr1ct6v3jH//g/PnzuhiJiHVhk0ZCQAg0EwJNErGag9lspkuXLhw7dqw6yrV1blUi//bbb7XUht5NRKyXnLQTAkKgORBosohVfjc4OJgHHniAXbt2ceXKlep5qai4Q4cO2s9q4a64uLj6dyo6fuqpp7QIWUXTly9f1s1DRKwbnTQUAkKgGRDQJWJVrvbggw/y0EMP4ejoWD2NHTt2UFBQoP2sStWeeOIJlHDV9tNPP2nlbWfPntV+VuJWJW5KxGorKSnRUhzqX1X+2FY+ImJbScl+QkAINEcCukQ8evRobS4qwlXizM/P1/59//332ustWrTQJFu1MKdu2lDyVtJOSUmpzhG7uLhowjYajZrUW7durbXfvHlzo1iJiBuFS3YWAkKgmRHQLWIV+aoIuK6tbdu2DBo0SKsNViVsauvcuTM///nPtaj466+/rrOdiqBV1YWIuJmdJTIcISAEbimBWypiVRes6oNFxLf0GErnQkAI3OUEdIv43//+t5YPVqkJtdBWld+tSk0MHz5cS00oEZeWltKjRw8tNfH3v/+9uqxNpSZUWkLlm9Win5ubm9ZGIuK7/KyS4QsBIdAoArpErKSq5Kn+1bdYp6olVCpCVU6oTd1RZ7FYqmuFay/WqRs6lMxVnlmVwjVmkxxxY2jJvkJACDQ3ArpEbD2Jm5WvKUm3b99e2/3ixYtaZFy1WZevqedRqMU+vZuIWC85aScEhEBzINBkEcsNHc3hMMoYhIAQuJsJNEnEN7vFWUW86mFA1pt6TT2D4tq1a9Uvyy3Od/PpI2MXAkLAHgR0i7i+h/4oOasnqtX10B/1cB9VY6xu2Dh+/Lg2fnnojz0Oo/QhBITA3UxAt4jVpGs/BvORRx7RnjuhKirUYlxdj8Gs+l3tx2AqMavnGOvZJEesh5q0EQJCoLkQaJKI1STqejC8qnoICQmp88Hwn3/+ufYVSl5eXtUMVITc2EoJa4Ai4uZyOsk4hIAQ0EOgySJWb1r1VUkZGRnVz5Jo6KuSVDVFQEAA2dnZjX62RO2Jioj1HHppIwSEQHMhYBcRq8no+fJQlWdW9cVN3UTETSUo7YWAELiTBOwm4tqTUF8m6u/vX+PlM2fOaF+PZO9NRGxvotKfEBACt5PALRPx7ZyEiPh20pb3EgJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUBE3EhgsrsQEAJCwN4ERMT2Jir9CQEhIAQaSUATcYvIEY1sJrsLgXuHwJgPPe6dychM7koCIuK78rDJoO1JQERsT5rSlx4CImI91KTNPUVARHxPHc67cjIi4rvysMmg7UlARGxPmtKXHgIiYj3U9LRp0QoPZ8i5VqSntbS5CQFXt7Y4FeZx6Sd9mPSJ2EDLTi60pJir3xRTru+tbWpleKQrvk65HD1WbNP+t34nZx7qBN9/U994DLh2MmhcZLONgP1F3DqAuHGDyNwUz6ortg2iOe/V7rFIdg64wvTlCaTp/EMHB4JGLCCh9Wr8PzlESXOe8N02ttahbIp4gl1L3uA9nedbY0Rs6NSNJyOfZNATD+JQUk5RCbi2M/BdahqJcWmczLM3wI6EJs4gzOkg745M4kypvftvfH8PjZ3My2NP8l54Gt/VNZ62/kzf1I+T4R+w8+vG938/trCviDUJh0FaPFHH6/mrcPJm2qhwInw8aW8o5WLeaZYnLeK9s2V49Awnfmh/zO6tofgSp46vJ3zrAVxDFpDUaTt9/7KLS5VHycl7Gl+McmDu4iV8pluQDR9ypw4DifYuYnnaIXIa3r2ePUTEutE11PA2irhl/1Bmze/Kd0uT2LIxh6tVY3NsS+/IkTz/HwZ2Rqxk5+G64mMDHcY+y9Qofzq6FpOz4a98EHOM7xuYn2vYRH4bdpLtJUEEHkjg3TWXGyKC4fEgpi4Mwa8zXP3nQVZOT+ZkQYPNbNvBsSsTtoWSPzcZ15ggvpu+mr1WFx9D/1HMfiGHLYcDmPp4Gm9GHuPHGj270zt6PM9PNOF6NY8v4j5mzca8W/qJwraJ3dm97CdiWyQMBIQuYHP3XGK2biat0AGPTiY4u49dxQNZGzERtyMJRFvOUeJiwtw6j3VHz+FzB0Vsn8MjIrYPxzp6uV0i7tSPWWv7cD7iA7bUKVp4KGwiL0cVs2bkRo7WFt8jTzJ3Uz++j11H4nkPnl8cAnF/5P2NhfWjcezKLzaFUj53GVtKgvjtMhPbx9TRt3UPjh78YttU/Pav44M15fSdP54nzm/kf24Qor4jokT7WuQFlm7sxuxhXxI3I4OWw0IZPgyylu7E8nVbnkt8FqIP0mGxL/ufWscRq6jZdexk/jsKtkVs40znoUyNcWfPmGUk3+eRsz4RuwUwqeM5Vh2vvBS28Oa1SeG4pS2qPxLWjrsDzz3/f8T+tIS+m2p9RO8wjn2/fpR1dXzE9GtAxLs6h5MyzptP18Tw5jfXTzCnTiNJGDWcIHd3nDnL4tWrcXt2Jq7JrzDjeBm0CGDpy+O4uiaGqG/KoPWjzB4Rzos+D+NafolPt79BZHk4GcF5/PL/VnMIB/weC2ehitqdyzh3fh8xW1fzWV3BfwsT40dOI9rPR+srp9iN9heWVKQmWph4bng4r/l5054rWCwJTN+ZgVtQLCl++xm6YhunACfPcPaNc+PNd1bj9Owc5ni3pYuzI8WXj7HleB7dugfg5+7A1fP7mLs+gc+uqUb9WfpiOM+oTxWFZ/k0dQWRh85RgolJE35HtJc7blzGkrWa6VsPkENbxo+x6lu1SVlCZJaJ+IhpkBRRwQoTr02LxWx5hTGHrCfsgM9j4SwODsDs7sDFC8lM/vN6Djn789qoifzSqy2uxedYt30JUUfzwMmf2BfCea5jO9obrvH59hgmfBfC5lED8XNRx+ka587vImrTenap+dTY2vJ06DRie3vTxVDGySMrGJralrUR4+hWXIariwMleRks3LqEFep42rg1nJow0DPuJUZ+/RELl+bRYZg/xqP/5GjluWZ43J++nGT/YQPmpbMIOfwnbT/rrcOMWbw27EteH7tHi4I7R79EVM80ol84eD2yrjXeh6ZMZfbjacRpEjXQLXYWz139mIULL9Q7MyXK15c9SOKglewvAMOTY5m/2JlP+q3GYoe0Rsuxk4l6PI01jCTs2J94d4MHU3c8SVkq+Lru4fXIk3SNncXww3/lwpQQvlfpiWoULgxaM4eQox/wP/PV50t3Qja+xBP73+ethXbP6dh49JvHbvpE7PQor42biIclnhnqj0v7I5/JM6cTCD94+qY5UI+AOaQMN5GWupqFlkNkVSVMWzxK3ItzeK54H/N3JrLubF51Pw2J+DP3ISwN9eGzpBVssXKEU89IMoaWEbVmPRYcKC5wY+70+kTcivHPxxLrso+IpL2cwg2n4q841SmyWsRZnSaSMimAzG1LWPSNA0NCZzLXOZERHyZr4rTe/EJiSfLLY/7W9ewqNzE5dBrjC1doIvYImkeS+QrzN60mzXk4y8YEkLn+VSLLx7Fvkonlixex6hr4qD467GTA2tO8+Jt5mI/EEJnlgDl4JvHdr7BoUwJbLpuYPW4mQaffZmDyacANv06tuHi5jG69p5EwoIioxfFsKXHAo0MXbVGrpGMYCeP6k7n+FSJPm3jtN/MYcOQNpmeV4eEXzrIBZcxfsoSSEX/gtZJ4Bm79ihKnIax9OYTMP8fw5nfWF7tKJttXsOj0FVxd4NQ3RTwzYQHRbGZ68iHoPo1lA4qIUeMwqJxuCKfWx6P+9tzKc8nxVMepiKg1m8l09mb2qGmYT7/N0OSa55JPv3kkDSjiva3r2XLZAQ9DHmmF/bX+cjYtYVGeA0HBM4lz28nQDysuZrZsDYrYsQdTdwRxYswH7M1TKYbxzJhSzJbwjWS1C2LGMn8uzF3JhgPFmvhej7rEe2F7uI7JQO/4V5nERv4r8pj2MdwwdjLvRP7Ae09t5WRdgmzTg0mbgjg/fSU5U2Yx2Wk7r8c5M2NtT76YsJr99Xir5QtT+d8Zl3j3qa0V+eROQczdEcDJke+zxQ5RpyFsIq8/eYgPLg1lAht4a2ExoRtfYnQf+Dr2jyz8sJDe8bPo+/dtFEUGcX7MSvZWfTpQaY0dkzHGL+D9jWohT13g5jDVdRv/NSPjvk5P6BOxOrtry7hFFyaNm8ZzZxMITztd71UeWuH32GiiBwwkyL0Ii2U9USkHOKXyvG7+zB46mkndu+CWd4iFyQmsOFuEEvHOAQ9TXG59xjriXL6fye/UnyPWRFwdzQJK9jPrEfHlgWyKGE7WqleJsY6qq/tYj7NacHPbTN+1+yrmZxxJyotPsGX521wJXcxCH0fgGpvXv0XOk//NgKxXGZGm/mKsUxO5zJkWa/W7VoyfsJjZ+W8wMKUVcTMjaZ/yCuFHWzHtV7E8czyGMQdbabLs9flvmPBlGU7qgvBCWxa9E8+WnyrTPcZEfNfuq3kRdBrI2peHk7k8hjfzrZVkYvaUWIYciWDMobY1+q74lDCRkvWvEtN6Jl8MvUL4kgQsPjP5IrSI6UusFy0r52XNRL1N6yE1Wao+I8Ip2foKkRfU72ourtU+Tj7qk4H3zhprAupiP3taLM9UM62cT63UxPVPERVsbNkaFHGPUH6/0MDasCTOaB0a6PzCRGZMMXDFqSXnoxNYu6cyxdCmH7/d0ZWdg6w/khswfxjN6EsreT3qTIWIwybyvzHlrKqx3/XRdp47SxPUmzE5dI19Sft/dOQxOla/XtFP7e2hKdN5/YUzxA1L5rz6pRrPwSByJvyRDYdtodHAPirFstiFDdEwaXFLtkzPYVBCHy5sKOdx74PExT/I1GUm9kT8QMh8AxuqmQGO3Zi0dzwtYxewLFGjQLfYl5jdOYWXp/xTRKz7FmfdMlYH2wEP71DiR42mfVat6MepC+OHzySuex5RSxaR2X8BSZ6HmJC0n+qAt9NoPg4uu+liXaNEXD6alF978/Hit1lh9ZH4eh/r6fL84usRoppCi/4kvDyOi+tfZX5hF3yc1YtlXPqhFXOmRuKWEkH4UfUR2UrEm4qIm/l7fule84Q/d2ShFnkGjVrAYsNq+m53Y+3MQXy6/A1WXOlSU5bGcaS86M3Kd95mVQlUicv/L7soMQ4kbtRonunohlN5GTjnsVyJ+LI300aG86K3ifaGMkpwIHO7SjO41RKx1cUqO4CEmeO4uOlVtvgtIN6QwMCtGVayV6mmWkzUtDqo8YXRq8YUr/HpxgjCzzYsYteA35HR+0sGfrjt+gKpdhFVF6kqpnWLGI1NF5bHLWKdvURcKR8lYk1uSiGP9GPG2hF0vXqIpWO2Xl8M00TcjZ2DVlvlRhsZEbftw/S1PTmiRb4VsqoScXmbHkzdFMQZ9ZHfKmCoQn2rI2KVThi05j/pvfEjtmPC2GMAz3X+nLfmljNhRxBnIvZw1fUHysJ+ScixilRO9SYRcb1XOf0RcVWXbqFsmuTD8iWVkamKjJ8dTknKCtY1WE7kQMCIBWzusJ2BHybXrErQojkluVdY7hmrq2riBhHThdjfzMPn8wgmfFlUM0fcpIg4hvdqRZwqnxqSFcPQtNxaEXEec6bNqyPXWgFUi+jGtGLR527Edrcw9C+KS0MinkeK9178/3KAZyb8gTnlq5mwdR+nUAugw8lcFcMqz3nsM+cyfU0Cn11xY/aUBQw50oCIj6OV3S1z3smnHYbjlKxSGda515tFxCFYaqUxtAnWsbhW+zjVKWLFYNo8q08St1HENVIT6uN+H6YmBFMW9xF7vZ9l6rAcVoZXVCZoi1kxxSwNS7ZKTUBVjvjNsRUpi/pzxBW54OevfsxblbngDmGhDHL6kg0bK3LDHaZMZUZ17rjm37aWI054kMR+tyZHXHERCmJyZDmJ0T8wfMdEelOMdlY4OVP+t5W8Hu/M8/PbsT9iT61yu+s54jfn51AuOeLqg9c0EWsR8TjaW5YQqeWKG9ocCHgslF4lp7HkXQEXtTg2kQHfLaFvCkzya8Wps6fJKW6FT+9xLO7fiveWx7CzdwPla5U54l1JNeV/o4gdeHrMH1jsdoCIpO1k4U/cpOHkaIt1bkyaEEu08z4ikreTVexGO3LJ6jCtVo7Yn8xtKxrMEVfkM8tYmbSaVRfKMA/9HXEtErQcsZb71fLHm/nschGu7m5cVfPW8HkT+5s5jHeBzJRXKxfGGiPixcwpTyA86RCnUBFtLRGvX03aZTcmT1KpiYZEXFYR3f46FJ/iA4QvXsGun9DKDOP8vmX+J8mcUheOF/zJ2r6C+afzcHJvxdWzRQz5VSxzSWRu8gGyilvh4VKG5ZtcShol4l34hMzkxeJEwtO+0iL/pP5XWKRyxHlltHMpI+tyAGutUx23IiLGWct7jjz/EXEL8+gaPZHAw39lVaIqJXOm29zxhHzzV5atKdb2Cz2WcMNiHSqq3taP76PXkXjag+eX1VM18YiqjvBg55h1HKnMrXYIG0GI0yHWVooYrYRsJD9GvM+WY7X+5qyrJj4sp+9C+1ZNWL+b6wuT+f3YM7xbeXFBjT2hG+ljVtabw76hamK+O3tGStWEfhG39id23DhcD8TbKGF1CN0YEqIqCbzxcW+Nc/llMk/tY37Sena5DGHpiDAGdHSjvQGuXD7Hp6kJRH3ZcPnars4TSRn36I1VE7VzxNoQ+hM3ZiLjO7vjXH6Ni5e/YuH6eFapiLZ1xUr/ZK+HKyoLUuMZfTms7qoJlzLOZd+kagK1wh9OdO9H6aYqHYovYbGsYMLOr2pUTXRxVnM9RNSfl7ClMiWipRoG5BGpLbKpQdsq4l2UdApl2ajRDGmr+JZypTCD+aviWVWsLprTmNy5HW4G9XpeRVXI0do54lp5dNyY9Ks/MDv/bQYmVSye+QXNY7OKrpcoMTvgFxDOwuD+mF0q57J8CVsM1iyvcS57PRPW7uJUo0R8gCETYplbnkDIJwe4ZFVtorhdPLWaEVsdiL/lIgZNMmv7cWHun67ng2s58KGw8cyO/JFPxmy9sXyN63XEHq7FfF1nHbES/gxCDn/Eux9eD2xa9uhGV3Vn3eHrpW5KaFFa+dg/b1iPqa4j9jZwdX8aayKSsSlOaiiOqvH7jjyXOINBTjmcOV+VrTZg7ONB2eql1dH8jV260zt2PBN+0YVWV3M5EvcxK6WOGH0irpRwuwNVVRONOoKy811BoBWuTuDWeTTLRnXh4z+/fU/cKVkX+gYX6yobuQ4bxaz5vlzdsI1P4o9dv6us6oaO0HK2R6xj7zGdNzyrFMje8fQsKax1E0Rdozbg6prLmsoytdt9SlVUh/zIJ9EZNS8Erj34RUwbtqlaajuUy93ued2p99MnYrcAxnc8x7qqOuI7NXp531tHwDiSpBfH41d86noN8K17tzvas60irsiP+hMWFUzfPs6UXSqgiJa4ucKF1DS2xR/kjC0ZugZma3A02MSjvFSn8G3q/eY7uQ57kidKDpK8p/bzJJzpOeVJHJKTOVLHYqId3vqe7EKfiO9JFDKp+5VAY0RczcjRGdd2LhhKCrmad2sf+nO/Hpf7ad4i4vvpaMtc6ySgS8TCUgjYkYCI2I4wpau7k4CI+O48bvfSqEXE99LRlLnoIiAi1oVNGtmRgIjYjjClq7uTgIj47jxu99Ko/x/HmHxRljJAeAAAAABJRU5ErkJggg=="},80759:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/rucio-server-debug-98c2ec8a56860d6718e4da5bf97bc709.jpeg"},46399:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/images/rucio-tasks-a9f11e37004c47a3ee27c6549b968aee.jpg"},28453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(96540);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/26c807fc.4c612c17.js b/assets/js/26c807fc.4c612c17.js new file mode 100644 index 0000000000..bb279430a7 --- /dev/null +++ b/assets/js/26c807fc.4c612c17.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[1788],{2621:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"started/concepts/metadata_attributes","title":"Metadata attributes","description":"Meta-data associated with a dataset/file is represented using","source":"@site/../docs/started/concepts/metadata_attributes.md","sourceDirName":"started/concepts","slug":"/started/concepts/metadata_attributes","permalink":"/documentation/started/concepts/metadata_attributes","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/metadata_attributes.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"metadata_attributes","title":"Metadata attributes"},"sidebar":"docs","previous":{"title":"Rucio Storage Element","permalink":"/documentation/started/concepts/rucio_storage_element"},"next":{"title":"Permission model","permalink":"/documentation/started/concepts/permission_model"}}');var n=a(74848),i=a(28453);const o={id:"metadata_attributes",title:"Metadata attributes"},r=void 0,c={},d=[];function u(t){const e={code:"code",li:"li",p:"p",ul:"ul",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.p,{children:"Meta-data associated with a dataset/file is represented using\nattribute/value pairs. Meta-data attributes are classified into four\ncategories:"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"System-defined attributes"}),": size (bytes), checksums (adler32, md5),\ncreationtime, modificationtime, status, length (datasets/containers)"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Physics attributes"}),": GUID, number of events, project, datatype, run_number,\nstream_name, prod_step, version, campaign, lumiblocknr"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Workflow management attributes"}),": storing information like which task\n(task_id) or job (panda_id) produced the file"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Data management attributes"}),": necessary for the organisation of data on the\ngrid (see Replica Management section)"]}),"\n"]}),"\n",(0,n.jsx)(e.p,{children:"For datasets, it is possible that the value of a meta-data attribute is\na function of the meta-data of its constituents, e.g. the total size is\nthe sum of the sizes of the constituents. In this case it is not\npossible to assign a value to it."})]})}function l(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(u,{...t})}):u(t)}},28453:(t,e,a)=>{a.d(e,{R:()=>o,x:()=>r});var s=a(96540);const n={},i=s.createContext(n);function o(t){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:o(t.components),s.createElement(i.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/26c807fc.b7d652a9.js b/assets/js/26c807fc.b7d652a9.js deleted file mode 100644 index dab25feab5..0000000000 --- a/assets/js/26c807fc.b7d652a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[1788],{2621:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"started/concepts/metadata_attributes","title":"Metadata attributes","description":"Meta-data associated with a dataset/file is represented using","source":"@site/../docs/started/concepts/metadata_attributes.md","sourceDirName":"started/concepts","slug":"/started/concepts/metadata_attributes","permalink":"/documentation/started/concepts/metadata_attributes","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/metadata_attributes.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"metadata_attributes","title":"Metadata attributes"},"sidebar":"docs","previous":{"title":"Rucio Storage Element","permalink":"/documentation/started/concepts/rucio_storage_element"},"next":{"title":"Permission model","permalink":"/documentation/started/concepts/permission_model"}}');var n=a(74848),i=a(28453);const o={id:"metadata_attributes",title:"Metadata attributes"},r=void 0,c={},d=[];function u(t){const e={code:"code",li:"li",p:"p",ul:"ul",...(0,i.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.p,{children:"Meta-data associated with a dataset/file is represented using\nattribute/value pairs. Meta-data attributes are classified into four\ncategories:"}),"\n",(0,n.jsxs)(e.ul,{children:["\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"System-defined attributes"}),": size (bytes), checksums (adler32, md5),\ncreationtime, modificationtime, status, length (datasets/containers)"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Physics attributes"}),": GUID, number of events, project, datatype, run_number,\nstream_name, prod_step, version, campaign, lumiblocknr"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Workflow management attributes"}),": storing information like which task\n(task_id) or job (panda_id) produced the file"]}),"\n",(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"Data management attributes"}),": necessary for the organisation of data on the\ngrid (see Replica Management section)"]}),"\n"]}),"\n",(0,n.jsx)(e.p,{children:"For datasets, it is possible that the value of a meta-data attribute is\na function of the meta-data of its constituents, e.g. the total size is\nthe sum of the sizes of the constituents. In this case it is not\npossible to assign a value to it."})]})}function l(t={}){const{wrapper:e}={...(0,i.R)(),...t.components};return e?(0,n.jsx)(e,{...t,children:(0,n.jsx)(u,{...t})}):u(t)}},28453:(t,e,a)=>{a.d(e,{R:()=>o,x:()=>r});var s=a(96540);const n={},i=s.createContext(n);function o(t){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function r(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:o(t.components),s.createElement(i.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/31b36657.664d5ced.js b/assets/js/31b36657.664d5ced.js new file mode 100644 index 0000000000..2175a853ce --- /dev/null +++ b/assets/js/31b36657.664d5ced.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8610],{89349:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"operator/transfers/transfers-overview","title":"Transfers Overview","description":"Rucio has a set of daemons in charge of transfers between rucio storage elements","source":"@site/../docs/operator/transfers/transfers_overview.md","sourceDirName":"operator/transfers","slug":"/operator/transfers/transfers-overview","permalink":"/documentation/operator/transfers/transfers-overview","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/transfers/transfers_overview.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"transfers-overview","title":"Transfers Overview"},"sidebar":"docs","previous":{"title":"Configuration parameters","permalink":"/documentation/operator/configuration_parameters"},"next":{"title":"Transfers Preparer","permalink":"/documentation/operator/transfers/transfers-preparer"}}');var s=n(74848),o=n(28453);const i={id:"transfers-overview",title:"Transfers Overview"},a=void 0,l={},c=[{value:"Daemon overview",id:"daemon-overview",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Rucio has a set of daemons in charge of transfers between rucio storage elements\n(RSE). Historically, these daemons were grouped under the name of ",(0,s.jsx)(t.code,{children:"conveyor"}),",\nso a big part of the documentation and source code still uses this naming\nwhen referring to the transfer machinery."]}),"\n",(0,s.jsxs)(t.p,{children:["Rucio doesn't execute the actual physical data movement between storage\nelements. It relies on external tools for this scope. Currently, rucio supports\n",(0,s.jsx)(t.a,{href:"https://fts3-docs.web.cern.ch/fts3-docs/docs/overview.html",children:"fts3"})," and\n",(0,s.jsx)(t.a,{href:"https://www.globus.org/data-transfer",children:"globus"}),'. Rucio builds on top of these\n"TransferTools" and provides additional services like recovery from a transfer\nfailure by using another copy from another storage element, multi-hopping\nusing multiple transfertools (or multiple instances of the same transfertool\ntype) and others.']}),"\n",(0,s.jsx)(t.h2,{id:"daemon-overview",children:"Daemon overview"}),"\n",(0,s.jsx)(t.p,{children:"The following transfer-related daemons exist in rucio, presented in the order\nthey intervene in a transfer lifecycle:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"preparer"}),": a strongly recommended optional daemon which is required for\nmany advanced usages, like multiple transfertools together.\nIt is also required to be able to use throttler. If active, performs part\nof the source selection and path computation work instead of the submitter.\nFor all new rucio installation, it is recommended to run this daemon and\nactivate it by setting the ",(0,s.jsx)(t.code,{children:"conveyor/use_preparer = True"})," configuration\noption."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"throttler"}),": an optional daemon which can throttle request submissions\nto/from an RSE"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"submitter"}),", ",(0,s.jsx)(t.strong,{children:"stager"}),": perform the actual submission of transfers to the\nexternal transfertool. If used without preparer, also perform path computation\nand source replica selection. Stager is a specialized submitter for issuing\nstagein operations to tape archives."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"receiver"}),": optional daemons which listens for events published into a\nqueueing system (activemq) by the external transfertool and reacts to those\nevents to mark transfers as successful or failed."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"poller"}),": regularly polls the external transfertool for the status of\npending transfers and marks them as successful/failed"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"finisher"}),": acts on successful or failed transfers. For example, by\nre-scheduling a new attempt."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["The minimal list of daemons needed for transfer execution is:\n",(0,s.jsx)(t.code,{children:"submitter"}),", ",(0,s.jsx)(t.code,{children:"poller"})," and ",(0,s.jsx)(t.code,{children:"finisher"}),"."]}),"\n",(0,s.jsx)(t.h1,{id:"lifecycle-of-transfer-requests",children:"Lifecycle of transfer requests"}),"\n",(0,s.jsx)(t.p,{children:"There is no user-facing way to schedule a transfer. All transfer requests are\ncreated internally by rucio as result of rule evaluations. The lifetime of a\nrucio transfer is thus strongly bound to the rule which created it.\nHereafter is a simple example which gives the intuition of how rucio proceeds\nwith a replication/transfer of a file as part of a rule."}),"\n",(0,s.jsx)(t.p,{children:"In the rest of this example we'll assume the following 4 rucio storage\nelements:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-text",children:"\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510 5 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2500\u2500\u2500\u25ba\u2502 \u2502\n\u2502 RSE1 \u2502 \u2502 RSE2 \u2502\n\u2502 \u2502 \u250c\u2500\u2500\u25ba\u2502 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2502 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u25b2 \u2502\n \u2502100 \u25023\n \u25bc \u2502\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u2502 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2518 \u2502 \u2502\n\u2502 RSE3 \u2502 \u2502 RSE4 \u2502\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2500\u2500\u2500\u25ba\u2502 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 2 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n"})}),"\n",(0,s.jsx)(t.p,{children:"The numbers on the arrows represent the administrative cost which is set\nby the rucio administrator. Cost is unidirectional, but, in this example,\nwe assume that the cost was configured identical in both directions.\nFor example:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"rucio-admin rse add-distance --distance 5 RSE1 RSE2\nrucio-admin rse add-distance --distance 5 RSE2 RSE1\n# Note: before rucio 1.30 (as a consequence: also in the current LTS release 1.29),\n# the --ranking option was used for the same purpose. The --distance option\n# could still be set and was mentioned in documentation alongside --ranking\n# but was completely ignored by rucio.\n# On 1.29, you'll have to use the following command:\nrucio-admin rse add-distance --ranking 5 RSE1 RSE2\nrucio-admin rse add-distance --ranking 5 RSE2 RSE1\n"})}),"\n",(0,s.jsxs)(t.p,{children:["Assume a certain dataset ",(0,s.jsx)(t.code,{children:"someScope:dsName"}),", which has two files\n",(0,s.jsx)(t.code,{children:"someScope:file1"})," and ",(0,s.jsx)(t.code,{children:"someScope:file2"}),", and both files are located on ",(0,s.jsx)(t.code,{children:"RSE1"}),"."]}),"\n",(0,s.jsx)(t.p,{children:"The destination of the transfer will be decided on the rule evaluation phase,\nFor example the user adds a rule to ensure that rucio maintains two copies\nfor each of the files on any of the RSEs."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"rucio add-rule someScope:dsName 2 '*'\n"})}),"\n",(0,s.jsxs)(t.p,{children:["The rule evaluation mechanism detects that a copy is already available\non RSE1, but one additional copy is needed to respect the rule requirements of\n2 copies. It will thus create a transfer request to one of the other 3 rses.\nAs of time of writing, the selection of the destination is random as\nlong as it respects the RSE expression. Here, ",(0,s.jsx)(t.code,{children:"*"})," matches any RSE.\nFor the seek of the example, lets assume that RSE4 was selected."]}),"\n",(0,s.jsxs)(t.p,{children:["The rule evaluation mechanism will then create two transfer requests, which\nwill be picked by the transfer machinery. Depending on the configuration value\n",(0,s.jsx)(t.code,{children:"conveyor/use_preparer"}),", the transfer will be either handled by the ",(0,s.jsx)(t.code,{children:"preparer"}),"\nor by the ",(0,s.jsx)(t.code,{children:"submitter"})," directly."]}),"\n",(0,s.jsxs)(t.p,{children:["At this stage, the transfer machinery finds all the possible sources. It\nfilters out the ones which don't match different rule criterias (for example:\nsource RSE expression) and administrative constraints (for example:\nskip blocklisted RSEs). It then computes the paths. In the previous example,\nthe path ",(0,s.jsx)(t.code,{children:"RSE1 -> RSE2 -> RSE3 -> RSE4"})," will be picked due to cost constraints.\nNote that it's possible to make rucio prefer shorter parts by setting the RSE\nattribute ",(0,s.jsx)(t.code,{children:"hop_penalty"}),", or the global configuration value with the same name.\nFor more details about how a source is selected, refer to the ",(0,s.jsx)(t.a,{href:"/documentation/operator/transfers/transfers-preparer",children:"Preparer"}),"\ndocumentation."]}),"\n",(0,s.jsx)(t.p,{children:"The path will be then submitted to the transfertool either in its integrity,\nif transfertool supports multi-hopping, or in multiple iterations."}),"\n",(0,s.jsxs)(t.p,{children:["The final steps are for the ",(0,s.jsx)(t.code,{children:"reciver"})," or ",(0,s.jsx)(t.code,{children:"poller"})," to monitor the transfer's\ncompletion in transfertool and ",(0,s.jsx)(t.code,{children:"finisher"})," to mark the transfers as completed.\nWe only described here a simple case, when the transfer is successful on the\nfirst try. In case of errors, multiple transitions are possible between\ndifferent daemons. Check the following request state transition diagram\nfor a more detailed view:"]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Request State Transition Chart",src:n(77756).A+"",width:"3131",height:"7564"})})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},77756:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/request_state_transition_chart-ac293c9924265950b36ebc9d9ddf8895.svg"},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(96540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/31b36657.69f34a24.js b/assets/js/31b36657.69f34a24.js deleted file mode 100644 index 3fab6c64b6..0000000000 --- a/assets/js/31b36657.69f34a24.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[8610],{89349:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"operator/transfers/transfers-overview","title":"Transfers Overview","description":"Rucio has a set of daemons in charge of transfers between rucio storage elements","source":"@site/../docs/operator/transfers/transfers_overview.md","sourceDirName":"operator/transfers","slug":"/operator/transfers/transfers-overview","permalink":"/documentation/operator/transfers/transfers-overview","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/transfers/transfers_overview.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"transfers-overview","title":"Transfers Overview"},"sidebar":"docs","previous":{"title":"Configuration parameters","permalink":"/documentation/operator/configuration_parameters"},"next":{"title":"Transfers Preparer","permalink":"/documentation/operator/transfers/transfers-preparer"}}');var s=n(74848),o=n(28453);const i={id:"transfers-overview",title:"Transfers Overview"},a=void 0,l={},c=[{value:"Daemon overview",id:"daemon-overview",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Rucio has a set of daemons in charge of transfers between rucio storage elements\n(RSE). Historically, these daemons were grouped under the name of ",(0,s.jsx)(t.code,{children:"conveyor"}),",\nso a big part of the documentation and source code still uses this naming\nwhen referring to the transfer machinery."]}),"\n",(0,s.jsxs)(t.p,{children:["Rucio doesn't execute the actual physical data movement between storage\nelements. It relies on external tools for this scope. Currently, rucio supports\n",(0,s.jsx)(t.a,{href:"https://fts3-docs.web.cern.ch/fts3-docs/docs/overview.html",children:"fts3"})," and\n",(0,s.jsx)(t.a,{href:"https://www.globus.org/data-transfer",children:"globus"}),'. Rucio builds on top of these\n"TransferTools" and provides additional services like recovery from a transfer\nfailure by using another copy from another storage element, multi-hopping\nusing multiple transfertools (or multiple instances of the same transfertool\ntype) and others.']}),"\n",(0,s.jsx)(t.h2,{id:"daemon-overview",children:"Daemon overview"}),"\n",(0,s.jsx)(t.p,{children:"The following transfer-related daemons exist in rucio, presented in the order\nthey intervene in a transfer lifecycle:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"preparer"}),": a strongly recommended optional daemon which is required for\nmany advanced usages, like multiple transfertools together.\nIt is also required to be able to use throttler. If active, performs part\nof the source selection and path computation work instead of the submitter.\nFor all new rucio installation, it is recommended to run this daemon and\nactivate it by setting the ",(0,s.jsx)(t.code,{children:"conveyor/use_preparer = True"})," configuration\noption."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"throttler"}),": an optional daemon which can throttle request submissions\nto/from an RSE"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"submitter"}),", ",(0,s.jsx)(t.strong,{children:"stager"}),": perform the actual submission of transfers to the\nexternal transfertool. If used without preparer, also perform path computation\nand source replica selection. Stager is a specialized submitter for issuing\nstagein operations to tape archives."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"receiver"}),": optional daemons which listens for events published into a\nqueueing system (activemq) by the external transfertool and reacts to those\nevents to mark transfers as successful or failed."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"poller"}),": regularly polls the external transfertool for the status of\npending transfers and marks them as successful/failed"]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"finisher"}),": acts on successful or failed transfers. For example, by\nre-scheduling a new attempt."]}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["The minimal list of daemons needed for transfer execution is:\n",(0,s.jsx)(t.code,{children:"submitter"}),", ",(0,s.jsx)(t.code,{children:"poller"})," and ",(0,s.jsx)(t.code,{children:"finisher"}),"."]}),"\n",(0,s.jsx)(t.h1,{id:"lifecycle-of-transfer-requests",children:"Lifecycle of transfer requests"}),"\n",(0,s.jsx)(t.p,{children:"There is no user-facing way to schedule a transfer. All transfer requests are\ncreated internally by rucio as result of rule evaluations. The lifetime of a\nrucio transfer is thus strongly bound to the rule which created it.\nHereafter is a simple example which gives the intuition of how rucio proceeds\nwith a replication/transfer of a file as part of a rule."}),"\n",(0,s.jsx)(t.p,{children:"In the rest of this example we'll assume the following 4 rucio storage\nelements:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-text",children:"\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510 5 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2500\u2500\u2500\u25ba\u2502 \u2502\n\u2502 RSE1 \u2502 \u2502 RSE2 \u2502\n\u2502 \u2502 \u250c\u2500\u2500\u25ba\u2502 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2502 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u25b2 \u2502\n \u2502100 \u25023\n \u25bc \u2502\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u2502 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2518 \u2502 \u2502\n\u2502 RSE3 \u2502 \u2502 RSE4 \u2502\n\u2502 \u2502\u25c4\u2500\u2500\u2500\u2500\u2500\u2500\u25ba\u2502 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 2 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n"})}),"\n",(0,s.jsx)(t.p,{children:"The numbers on the arrows represent the administrative cost which is set\nby the rucio administrator. Cost is unidirectional, but, in this example,\nwe assume that the cost was configured identical in both directions.\nFor example:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"rucio-admin rse add-distance --distance 5 RSE1 RSE2\nrucio-admin rse add-distance --distance 5 RSE2 RSE1\n# Note: before rucio 1.30 (as a consequence: also in the current LTS release 1.29),\n# the --ranking option was used for the same purpose. The --distance option\n# could still be set and was mentioned in documentation alongside --ranking\n# but was completely ignored by rucio.\n# On 1.29, you'll have to use the following command:\nrucio-admin rse add-distance --ranking 5 RSE1 RSE2\nrucio-admin rse add-distance --ranking 5 RSE2 RSE1\n"})}),"\n",(0,s.jsxs)(t.p,{children:["Assume a certain dataset ",(0,s.jsx)(t.code,{children:"someScope:dsName"}),", which has two files\n",(0,s.jsx)(t.code,{children:"someScope:file1"})," and ",(0,s.jsx)(t.code,{children:"someScope:file2"}),", and both files are located on ",(0,s.jsx)(t.code,{children:"RSE1"}),"."]}),"\n",(0,s.jsx)(t.p,{children:"The destination of the transfer will be decided on the rule evaluation phase,\nFor example the user adds a rule to ensure that rucio maintains two copies\nfor each of the files on any of the RSEs."}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-shell",children:"rucio add-rule someScope:dsName 2 '*'\n"})}),"\n",(0,s.jsxs)(t.p,{children:["The rule evaluation mechanism detects that a copy is already available\non RSE1, but one additional copy is needed to respect the rule requirements of\n2 copies. It will thus create a transfer request to one of the other 3 rses.\nAs of time of writing, the selection of the destination is random as\nlong as it respects the RSE expression. Here, ",(0,s.jsx)(t.code,{children:"*"})," matches any RSE.\nFor the seek of the example, lets assume that RSE4 was selected."]}),"\n",(0,s.jsxs)(t.p,{children:["The rule evaluation mechanism will then create two transfer requests, which\nwill be picked by the transfer machinery. Depending on the configuration value\n",(0,s.jsx)(t.code,{children:"conveyor/use_preparer"}),", the transfer will be either handled by the ",(0,s.jsx)(t.code,{children:"preparer"}),"\nor by the ",(0,s.jsx)(t.code,{children:"submitter"})," directly."]}),"\n",(0,s.jsxs)(t.p,{children:["At this stage, the transfer machinery finds all the possible sources. It\nfilters out the ones which don't match different rule criterias (for example:\nsource RSE expression) and administrative constraints (for example:\nskip blocklisted RSEs). It then computes the paths. In the previous example,\nthe path ",(0,s.jsx)(t.code,{children:"RSE1 -> RSE2 -> RSE3 -> RSE4"})," will be picked due to cost constraints.\nNote that it's possible to make rucio prefer shorter parts by setting the RSE\nattribute ",(0,s.jsx)(t.code,{children:"hop_penalty"}),", or the global configuration value with the same name.\nFor more details about how a source is selected, refer to the ",(0,s.jsx)(t.a,{href:"/documentation/operator/transfers/transfers-preparer",children:"Preparer"}),"\ndocumentation."]}),"\n",(0,s.jsx)(t.p,{children:"The path will be then submitted to the transfertool either in its integrity,\nif transfertool supports multi-hopping, or in multiple iterations."}),"\n",(0,s.jsxs)(t.p,{children:["The final steps are for the ",(0,s.jsx)(t.code,{children:"reciver"})," or ",(0,s.jsx)(t.code,{children:"poller"})," to monitor the transfer's\ncompletion in transfertool and ",(0,s.jsx)(t.code,{children:"finisher"})," to mark the transfers as completed.\nWe only described here a simple case, when the transfer is successful on the\nfirst try. In case of errors, multiple transitions are possible between\ndifferent daemons. Check the following request state transition diagram\nfor a more detailed view:"]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Request State Transition Chart",src:n(77756).A+"",width:"3131",height:"7564"})})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},77756:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/request_state_transition_chart-ac293c9924265950b36ebc9d9ddf8895.svg"},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(96540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/34338e89.053ef520.js b/assets/js/34338e89.053ef520.js deleted file mode 100644 index 90f5ae4a54..0000000000 --- a/assets/js/34338e89.053ef520.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[756],{16762:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>l,toc:()=>c});const l=JSON.parse('{"id":"client_api/metaconventionsclient","title":"MetaConventionClient","description":"add\\\\_key","source":"@site/../docs/client_api/metaconventionsclient.md","sourceDirName":"client_api","slug":"/client_api/metaconventionsclient","permalink":"/documentation/client_api/metaconventionsclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/metaconventionsclient.md","tags":[],"version":"current","frontMatter":{"title":"MetaConventionClient"},"sidebar":"docs","previous":{"title":"LockClient","permalink":"/documentation/client_api/lockclient"},"next":{"title":"PingClient","permalink":"/documentation/client_api/pingclient"}}');var t=r(74848),o=r(28453);const s={title:"MetaConventionClient"},d=void 0,i={},c=[{value:"add_key",id:"add_key",level:2},{value:"list_keys",id:"list_keys",level:2},{value:"list_values",id:"list_values",level:2},{value:"add_value",id:"add_value",level:2},{value:"del_value",id:"del_value",level:2},{value:"del_key",id:"del_key",level:2},{value:"update_key",id:"update_key",level:2}];function a(e){const n={code:"code",h2:"h2",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"add_key",children:"add_key"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Sends the request to add an allowed key for DID metadata (update the DID Metadata Conventions table with a new key)."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,t.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key"}),": the name for the new key."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key_type"}),": the type of the key: all(container, dataset, file), collection(dataset or container), file, derived(compute from file for collection)."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"value_type"}),": the type of the value, if defined."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"value_regexp"}),": the regular expression that values should match, if defined."]})]})]}),(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Raises"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Duplicate"}),": if key already exists."]})})]}),(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Returns"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsx)(n.p,{children:"True if key was created successfully."})})]})]})})]}),"\n",(0,t.jsx)(n.h2,{id:"list_keys",children:"list_keys"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Sends the request to list all keys for DID Metadata Conventions."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsx)("tbody",{children:(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Returns"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsx)(n.p,{children:"a list containing the names of all keys."})})]})})})]}),"\n",(0,t.jsx)(n.h2,{id:"list_values",children:"list_values"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Sends the request to lists all allowed values for a DID key (all values for a key in DID Metadata Conventions)."}),(0,t.jsx)(n.p,{children:"."}),(0,t.jsx)(n.p,{children:":return: a list containing the names of all values for a key."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsx)("tbody",{})})]}),"\n",(0,t.jsx)(n.h2,{id:"add_value",children:"add_value"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Sends the request to add a value for a key in DID Metadata Convention."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsxs)("tbody",{children:[(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,t.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key"}),": the name for key."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"value"}),": the value."]})]})]}),(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Raises"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Duplicate"}),": if valid already exists."]})})]}),(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Returns"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsx)(n.p,{children:"True if value was created successfully."})})]})]})})]}),"\n",(0,t.jsx)(n.h2,{id:"del_value",children:"del_value"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Delete a key in the DID Metadata Conventions table."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsx)("tbody",{children:(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,t.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key"}),": the name for key."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"value"}),": the value."]})]})]})})})]}),"\n",(0,t.jsx)(n.h2,{id:"del_key",children:"del_key"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Delete an allowed key."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsx)("tbody",{children:(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key"}),": the name for key."]})})]})})})]}),"\n",(0,t.jsx)(n.h2,{id:"update_key",children:"update_key"}),"\n",(0,t.jsxs)("span",{style:{"white-space":"pre"},children:[(0,t.jsx)(n.p,{children:"Update a key."}),(0,t.jsx)("table",{style:{border:"none"},children:(0,t.jsx)("tbody",{children:(0,t.jsxs)("tr",{style:{border:"none"},children:[(0,t.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,t.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"key"}),": the name for key."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"type_"}),": the type of the value, if defined."]}),(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"regexp"}),": the regular expression that values should match, if defined."]})]})]})})})]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>d});var l=r(96540);const t={},o=l.createContext(t);function s(e){const n=l.useContext(o);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),l.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/34c34503.c8a1f0b4.js b/assets/js/34c34503.c8a1f0b4.js deleted file mode 100644 index 67e4d85246..0000000000 --- a/assets/js/34c34503.c8a1f0b4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4834],{39260:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>n,toc:()=>t});const n=JSON.parse('{"id":"client_api/replicaclient","title":"ReplicaClient","description":"quarantine\\\\_replicas","source":"@site/../docs/client_api/replicaclient.md","sourceDirName":"client_api","slug":"/client_api/replicaclient","permalink":"/documentation/client_api/replicaclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/replicaclient.md","tags":[],"version":"current","frontMatter":{"title":"ReplicaClient"},"sidebar":"docs","previous":{"title":"PingClient","permalink":"/documentation/client_api/pingclient"},"next":{"title":"RequestClient","permalink":"/documentation/client_api/requestclient"}}');var l=s(74848),i=s(28453);const o={title:"ReplicaClient"},d=void 0,c={},t=[{value:"quarantine_replicas",id:"quarantine_replicas",level:2},{value:"declare_bad_file_replicas",id:"declare_bad_file_replicas",level:2},{value:"declare_bad_did_replicas",id:"declare_bad_did_replicas",level:2},{value:"declare_suspicious_file_replicas",id:"declare_suspicious_file_replicas",level:2},{value:"get_did_from_pfns",id:"get_did_from_pfns",level:2},{value:"list_replicas",id:"list_replicas",level:2},{value:"list_suspicious_replicas",id:"list_suspicious_replicas",level:2},{value:"add_replica",id:"add_replica",level:2},{value:"add_replicas",id:"add_replicas",level:2},{value:"delete_replicas",id:"delete_replicas",level:2},{value:"update_replicas_states",id:"update_replicas_states",level:2},{value:"list_dataset_replicas",id:"list_dataset_replicas",level:2},{value:"list_dataset_replicas_bulk",id:"list_dataset_replicas_bulk",level:2},{value:"list_dataset_replicas_vp",id:"list_dataset_replicas_vp",level:2},{value:"list_datasets_per_rse",id:"list_datasets_per_rse",level:2},{value:"add_bad_pfns",id:"add_bad_pfns",level:2},{value:"set_tombstone",id:"set_tombstone",level:2}];function a(e){const r={code:"code",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(r.h2,{id:"quarantine_replicas",children:"quarantine_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Add quaratined replicas for RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"replicas"}),": List of replica infos: {'scope': (optional), 'name': (optional), 'path': (required)}."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": RSE name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse_id"}),": RSE id. Either RSE name or RSE id must be specified, but not both"]})]})]})})})]}),"\n",(0,l.jsx)(r.h2,{id:"declare_bad_file_replicas",children:"declare_bad_file_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Declare a list of bad replicas."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"replicas"}),": Either a list of PFNs (string) or a list of dicts {'scope': , 'name': , 'rse_id': or 'rse': }"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"reason"}),": The reason of the loss."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"force"}),": boolean, tell the serrver to ignore existing replica status in the bad_replicas table. Default: False"]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:'Dictionary {"rse_name": ["did: error",...]} - list of strings for DIDs failed to declare, by RSE'})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"declare_bad_did_replicas",children:"declare_bad_did_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Declare a list of bad replicas."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": The RSE where the bad replicas reside"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"dids"}),": The DIDs of the bad replicas"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"reason"}),": The reason of the loss."]})]})]})})})]}),"\n",(0,l.jsx)(r.h2,{id:"declare_suspicious_file_replicas",children:"declare_suspicious_file_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Declare a list of bad replicas."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"pfns"}),": The list of PFNs."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"reason"}),": The reason of the loss."]})]})]})})})]}),"\n",(0,l.jsx)(r.h2,{id:"get_did_from_pfns",children:"get_did_from_pfns"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Get the DIDs associated to a PFN on one given RSE"}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"pfns"}),": The list of PFNs."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": The RSE name."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"A list of dictionaries {pfn: {'scope': scope, 'name': name}}"})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_replicas",children:"list_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"List file replicas for a list of data identifiers (DIDs)."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"dids"}),": The list of data identifiers (DIDs) like :\n[{'scope': , 'name': }, {'scope': , 'name': }, ...]"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"schemes"}),": A list of schemes to filter the replicas. (e.g. file, http, ...)"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"ignore_availability"}),": Also include replicas from blocked RSEs into the list"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"metalink"}),": ",(0,l.jsx)(r.code,{children:"False"})," (default) retrieves as JSON,\n",(0,l.jsx)(r.code,{children:"True"})," retrieves as metalink4+xml."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse_expression"}),": The RSE expression to restrict replicas on a set of RSEs."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"client_location"}),": Client location dictionary for PFN modification {'ip', 'fqdn', 'site', 'latitude', 'longitude'}"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"sort"}),": Sort the replicas: ",(0,l.jsx)(r.code,{children:"geoip"})," - based on src/dst IP topographical distance\n",(0,l.jsx)(r.code,{children:"closeness"})," - based on src/dst closeness\n",(0,l.jsx)(r.code,{children:"dynamic"})," - Rucio Dynamic Smart Sort (tm)"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"domain"}),": Define the domain. None is fallback to 'wan', otherwise 'wan, 'lan', or 'all'"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"signature_lifetime"}),": If supported, in seconds, restrict the lifetime of the signed PFN."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"nrandom"}),": pick N random replicas. If the initial number of replicas is smaller than N, returns all replicas."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"resolve_archives"}),": When set to True, find archives which contain the replicas."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"resolve_parents"}),": When set to True, find all parent datasets which contain the replicas."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"updated_after"}),": epoch timestamp or datetime object (UTC time), only return replicas updated after this time"]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"A list of dictionaries with replica information."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_suspicious_replicas",children:"list_suspicious_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"List file replicas tagged as suspicious."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse_expression"}),": The RSE expression to restrict replicas on a set of RSEs."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"younger_than"}),": Datetime object to select the replicas which were declared since younger_than date. Default value = 10 days ago."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"nattempts"}),": The minimum number of replica appearances in the bad_replica DB table from younger_than date. Default value = 0."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"state"}),": State of the replica, either 'BAD' or 'SUSPICIOUS'. No value returns replicas with either state."]})]})]})})})]}),"\n",(0,l.jsx)(r.h2,{id:"add_replica",children:"add_replica"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Add file replicas to a RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": the RSE name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"scope"}),": The scope of the file."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"name"}),": The name of the file."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"bytes_"}),": The size in bytes."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"adler32"}),": adler32 checksum."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"pfn"}),": PFN of the file for non deterministic RSE."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"md5"}),": md5 checksum."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"meta"}),": Metadata attributes."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"True if files were created successfully."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"add_replicas",children:"add_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Bulk add file replicas to a RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": the RSE name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"files"}),": The list of files. This is a list of DIDs like :\n[{'scope': , 'name': }, {'scope': , 'name': }, ...]"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"ignore_availability"}),": Ignore the RSE blocklsit."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"True if files were created successfully."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"delete_replicas",children:"delete_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Bulk delete file replicas from a RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": the RSE name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"files"}),": The list of files. This is a list of DIDs like :\n[{'scope': , 'name': }, {'scope': , 'name': }, ...]"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"ignore_availability"}),": Ignore the RSE blocklist."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"True if files have been deleted successfully."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"update_replicas_states",children:"update_replicas_states"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Bulk update the file replicas states from a RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": the RSE name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"files"}),": The list of files. This is a list of DIDs like :\n[{'scope': , 'name': , 'state': }, {'scope': , 'name': , 'state': }, ...],\nwhere a state value can be either of:\n'A' (AVAILABLE)\n'U' (UNAVAILABLE)\n'C' (COPYING)\n'B' (BEING_DELETED)\n'D' (BAD)\n'T' (TEMPORARY_UNAVAILABLE)"]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"True if replica states have been updated successfully, otherwise an exception is raised."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_dataset_replicas",children:"list_dataset_replicas"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsxs)(r.p,{children:["List dataset replicas for a did (scope",":name",")."]}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"scope"}),": The scope of the dataset."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"name"}),": The name of the dataset."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"deep"}),": Lookup at the file level."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"A list of dict dataset replicas."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_dataset_replicas_bulk",children:"list_dataset_replicas_bulk"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsxs)(r.p,{children:["List dataset replicas for a did (scope",":name",")."]}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"dids"}),": The list of DIDs of the datasets."]})})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"A list of dict dataset replicas."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_dataset_replicas_vp",children:"list_dataset_replicas_vp"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsxs)(r.p,{children:["List dataset replicas for a DID (scope",":name",") using the"]}),(0,l.jsx)(r.p,{children:"Virtual Placement service."}),(0,l.jsx)(r.p,{children:"NOTICE: This is an RnD function and might change or go away at any time."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"scope"}),": The scope of the dataset."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"name"}),": The name of the dataset."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"deep"}),": Lookup at the file level."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"If VP exists a list of dicts of sites"})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"list_datasets_per_rse",children:"list_datasets_per_rse"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"List datasets at a RSE."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"rse"}),": the rse name."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"filters"}),": dictionary of attributes by which the results should be filtered."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"limit"}),": limit number."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"A list of dict dataset replicas."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"add_bad_pfns",children:"add_bad_pfns"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Declare a list of bad replicas."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsxs)("tbody",{children:[(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"pfns"}),": The list of PFNs."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"reason"}),": The reason of the loss."]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"state"}),": The state of the replica. Either BAD, SUSPICIOUS, TEMPORARY_UNAVAILABLE"]}),(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"expires_at"}),": Specify a timeout for the TEMPORARY_UNAVAILABLE replicas. None for BAD files."]})]})]}),(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Returns"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsx)(r.p,{children:"True if PFNs were created successfully."})})]})]})})]}),"\n",(0,l.jsx)(r.h2,{id:"set_tombstone",children:"set_tombstone"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(r.p,{children:"Set a tombstone on a list of replicas."}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.strong,{children:"Arguments"}),":"]})}),(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(r.p,{children:[(0,l.jsx)(r.code,{children:"replicas"}),": list of replicas."]})})]})})})]})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,l.jsx)(r,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},28453:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>d});var n=s(96540);const l={},i=n.createContext(l);function o(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:o(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/37fa40ce.32bda3fe.js b/assets/js/37fa40ce.32bda3fe.js deleted file mode 100644 index c7b0d0bb90..0000000000 --- a/assets/js/37fa40ce.32bda3fe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2590],{96553:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"client_api/lifetimeclient","title":"LifetimeClient","description":"list\\\\_exceptions","source":"@site/../docs/client_api/lifetimeclient.md","sourceDirName":"client_api","slug":"/client_api/lifetimeclient","permalink":"/documentation/client_api/lifetimeclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/lifetimeclient.md","tags":[],"version":"current","frontMatter":{"title":"LifetimeClient"},"sidebar":"docs","previous":{"title":"ImportClient","permalink":"/documentation/client_api/importclient"},"next":{"title":"LockClient","permalink":"/documentation/client_api/lockclient"}}');var o=n(74848),c=n(28453);const s={title:"LifetimeClient"},r=void 0,l={},d=[{value:"list_exceptions",id:"list_exceptions",level:2},{value:"add_exception",id:"add_exception",level:2}];function a(e){const t={code:"code",h2:"h2",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h2,{id:"list_exceptions",children:"list_exceptions"}),"\n",(0,o.jsxs)("span",{style:{"white-space":"pre"},children:[(0,o.jsx)(t.p,{children:"List exceptions to Lifetime Model."}),(0,o.jsx)("table",{style:{border:"none"},children:(0,o.jsx)("tbody",{children:(0,o.jsxs)("tr",{style:{border:"none"},children:[(0,o.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"Arguments"}),":"]})}),(0,o.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"id"}),": The id of the exception"]}),(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"states"}),": The states to filter"]})]})]})})})]}),"\n",(0,o.jsx)(t.h2,{id:"add_exception",children:"add_exception"}),"\n",(0,o.jsxs)("span",{style:{"white-space":"pre"},children:[(0,o.jsx)(t.p,{children:"Add exceptions to Lifetime Model."}),(0,o.jsx)("table",{style:{border:"none"},children:(0,o.jsx)("tbody",{children:(0,o.jsxs)("tr",{style:{border:"none"},children:[(0,o.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"Arguments"}),":"]})}),(0,o.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"dids"}),": The list of dids"]}),(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"account"}),": The account of the requester."]}),(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"pattern"}),": The account."]}),(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"comments"}),": The comments associated to the exception."]}),(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.code,{children:"expires_at"}),": The expiration date of the exception.\nreturns: The id of the exception."]})]})]})})})]})]})}function p(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>r});var i=n(96540);const o={},c=i.createContext(o);function s(e){const t=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3c621cea.2eb26175.js b/assets/js/3c621cea.2eb26175.js deleted file mode 100644 index e65b9e6fe0..0000000000 --- a/assets/js/3c621cea.2eb26175.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[283],{32070:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>t,frontMatter:()=>_,metadata:()=>l,toc:()=>d});const l=JSON.parse('{"id":"operator/installing_daemons","title":"Installing Rucio Daemons","description":"Prerequisites","source":"@site/../docs/operator/installing_daemons.md","sourceDirName":"operator","slug":"/operator/installing_daemons","permalink":"/documentation/operator/installing_daemons","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/installing_daemons.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"id":"installing_daemons","title":"Installing Rucio Daemons"},"sidebar":"docs","previous":{"title":"Installing Rucio Server","permalink":"/documentation/operator/installing_server"},"next":{"title":"Configuration","permalink":"/documentation/operator/configuration"}}');var r=i(74848),s=i(28453);const _={id:"installing_daemons",title:"Installing Rucio Daemons"},c=void 0,a={},d=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Install via pip",id:"install-via-pip",level:2},{value:"Install via Docker",id:"install-via-docker",level:2},{value:"Environment Variables",id:"environment-variables",level:2},{value:"RUCIO_DAEMON",id:"rucio_daemon",level:3},{value:"RUCIO_DAEMON_ARGS",id:"rucio_daemon_args",level:3},{value:"RUCIO_ENABLE_LOGS",id:"rucio_enable_logs",level:3},{value:"RUCIO_CFG configuration parameters",id:"rucio_cfg-configuration-parameters",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsx)(n.p,{children:"The Rucio daemons run on Python 2.7, 3.6 and 3.7 on any Unix-like\nplatform."}),"\n",(0,r.jsx)(n.h2,{id:"install-via-pip",children:"Install via pip"}),"\n",(0,r.jsx)(n.p,{children:"Heads up: We recommend to use the docker-based install (see next\nsection) as it will configure many things for you automatically. Only\nuse the pip-based install if you have a good reason and know how to\nconfigure your web service manually:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"pip install rucio\n"})}),"\n",(0,r.jsxs)(n.p,{children:["This will pull the latest release from\n",(0,r.jsx)(n.a,{href:"https://pypi.python.org/pypi/rucio/",children:(0,r.jsx)(n.strong,{children:"PyPi"})}),". The Rucio server also needs\nseveral Python dependencies. These are all listed in the file\n",(0,r.jsx)(n.a,{href:"https://github.com/rucio/rucio/blob/master/requirements/requirements.server.txt",children:(0,r.jsx)(n.code,{children:"requirements.server.txt"})}),"\nand will be pulled in as necessary."]}),"\n",(0,r.jsx)(n.h2,{id:"install-via-docker",children:"Install via Docker"}),"\n",(0,r.jsx)(n.p,{children:"This image provides the Rucio daemons. Each daemon has to be run in a\nseparate container. It supports MySQL, PostgreSQL, Oracle, and SQLite as\ndatabase backends."}),"\n",(0,r.jsxs)(n.p,{children:["This image expects that there is an already initialised Rucio DB. To\nstart a simple ",(0,r.jsx)(n.code,{children:"judge-cleaner"})," daemon using a database on\n",(0,r.jsx)(n.code,{children:"mysql.db"})," without any additional parameters just run this:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'docker run --name=rucio-judge-cleaner \\\n -e RUCIO_CFG_DATABASE_DEFAULT="mysql+pymysql://rucio:rucio@mysql.db/rucio" \\\n -e RUCIO_DAEMON=judge-cleaner \\\n rucio/rucio-daemons\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"RUCIO_DAEMON"})," environment variable gives the name of\nthe rucio daemon."]}),"\n",(0,r.jsxs)(n.p,{children:["Rucio can be configured fully using environment variables like\n",(0,r.jsx)(n.code,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),". If you want to instead use a\ncomplete rucio.cfg it can also be mounted. This will then ignore the\n",(0,r.jsx)(n.code,{children:"RUCIO_CFG"})," environment variables:"]}),"\n",(0,r.jsx)(n.p,{children:"The rucio.cfg is used to configure the database backend and the daemons:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --name=rucio-judge-cleaner \\\n -v /tmp/rucio.cfg:/opt/rucio/etc/rucio.cfg \\\n -e RUCIO_DAEMON=judge-cleaner \\\n rucio/rucio-daemons\n"})}),"\n",(0,r.jsxs)(n.p,{children:["By default the daemon logs are written to stdout and stderr if you want\nto write to a file you can use ",(0,r.jsx)(n.code,{children:"RUCIO_ENABLE_LOGS"})," like\nthis:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --name=rucio-judge-cleaner \\\n -v /tmp/rucio.cfg:/opt/rucio/etc/rucio.cfg \\\n -v /tmp/logs:/var/log/rucio -e RUCIO_DAEMON=judge-cleaner \\\n -e RUCIO_ENABLE_LOGS=True \\\n rucio/rucio-daemons\n"})}),"\n",(0,r.jsx)(n.h2,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,r.jsxs)(n.p,{children:["As shown in the examples above the rucio-daemon image can be configured\nusing environment variables that are passed with ",(0,r.jsx)(n.code,{children:"docker run"}),".\nBelow is a list of all available variables and their behaviour:"]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_daemon",children:"RUCIO_DAEMON"}),"\n",(0,r.jsxs)(n.p,{children:["This variable is mandatory and it specifies the name of the daemon,\ne.g., ",(0,r.jsx)(n.code,{children:"hermes"}),", ",(0,r.jsx)(n.code,{children:"kronos"}),",\n",(0,r.jsx)(n.code,{children:"judge-evaluator"}),", etc."]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_daemon_args",children:"RUCIO_DAEMON_ARGS"}),"\n",(0,r.jsxs)(n.p,{children:["Any additional command line parameter can be specified here, e.g.,\n",(0,r.jsx)(n.code,{children:"\\--run-once"})," This field is optional."]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_enable_logs",children:"RUCIO_ENABLE_LOGS"}),"\n",(0,r.jsxs)(n.p,{children:["By default, the log output of the daemon is written to stdout and\nstderr. If you set this variable to ",(0,r.jsx)(n.code,{children:"True"})," the output will\nbe written to ",(0,r.jsx)(n.code,{children:"access_log"})," and ",(0,r.jsx)(n.code,{children:"error_log"})," under\n",(0,r.jsx)(n.code,{children:"/var/log/rucio"})]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_cfg-configuration-parameters",children:"RUCIO_CFG configuration parameters"}),"\n",(0,r.jsxs)(n.p,{children:["Environment variables can be used to set values for the auto-generated\nrucio.cfg. The names are derived from the actual names in the\nconfiguration file prefixed by ",(0,r.jsx)(n.code,{children:"RUCIO_CFG"}),", e.g., the\n",(0,r.jsx)(n.code,{children:"default"})," value in the ",(0,r.jsx)(n.code,{children:"database"})," section\nbecomes ",(0,r.jsx)(n.code,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),". All available\nenvironment variables are:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_ACCOUNTS_SPECIAL_ACCOUNTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_LOGDIR"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_LOGLEVEL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_MAILTEMPLATEDIR"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_RESET_ON_RETURN"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_ECHO"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_RECYCLE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_SIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_MAX_OVERFLOW"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POWUSERACCOUNT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POWUSERPASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_CARBON_SERVER"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_CARBON_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_USER_SCOPE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_POLICY"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_LFN2PFN_ALGORITHM_DEFAULT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SUPPORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SUPPORT_RUCIO"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SITES"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SLEEP_TIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_DATASET_LIFETIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SET_METADATA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUDITOR_RESULTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUDITOR_CACHE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_SCHEME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_TRANSFERTOOL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_FTSHOSTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_CACERT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USERCERT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_CACHE_TIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USE_DETERMINISTIC_ID"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_POLL_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_SUBMIT_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_BRING_ONLINE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_QUEUE_MODE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USING_MEMCACHE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_FTSMONHOSTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_USERNAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_PASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_NONSSL_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_USE_SSL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_EMAIL_FROM"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_EMAIL_TEST"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_QUEUE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_PREFETCH_SIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_CHUNKSIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SUBSCRIPTION_ID"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_USE_SSL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_RECONNECT_ATTEMPTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_EXCLUDED_USRDNS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_USERNAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_PASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_DATASET_WAIT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_ACCOUNT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CREDENTIALS_GCS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CREDENTIALS_SIGNATURE_LIFETIME"}),"\n"]})]})}function t(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>_,x:()=>c});var l=i(96540);const r={},s=l.createContext(r);function _(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:_(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3c621cea.d10a2ad7.js b/assets/js/3c621cea.d10a2ad7.js new file mode 100644 index 0000000000..1cb22ca88c --- /dev/null +++ b/assets/js/3c621cea.d10a2ad7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[283],{32070:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>t,frontMatter:()=>s,metadata:()=>l,toc:()=>d});const l=JSON.parse('{"id":"operator/installing_daemons","title":"Installing Rucio Daemons","description":"Prerequisites","source":"@site/../docs/operator/installing_daemons.md","sourceDirName":"operator","slug":"/operator/installing_daemons","permalink":"/documentation/operator/installing_daemons","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/operator/installing_daemons.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"id":"installing_daemons","title":"Installing Rucio Daemons"},"sidebar":"docs","previous":{"title":"Installing Rucio Server","permalink":"/documentation/operator/installing_server"},"next":{"title":"Configuration","permalink":"/documentation/operator/configuration"}}');var r=i(74848),_=i(28453);const s={id:"installing_daemons",title:"Installing Rucio Daemons"},c=void 0,a={},d=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Install via pip",id:"install-via-pip",level:2},{value:"Install via Docker",id:"install-via-docker",level:2},{value:"Environment Variables",id:"environment-variables",level:2},{value:"RUCIO_DAEMON",id:"rucio_daemon",level:3},{value:"RUCIO_DAEMON_ARGS",id:"rucio_daemon_args",level:3},{value:"RUCIO_ENABLE_LOGS",id:"rucio_enable_logs",level:3},{value:"RUCIO_CFG configuration parameters",id:"rucio_cfg-configuration-parameters",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,_.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsx)(n.p,{children:"The Rucio daemons run on Python 2.7, 3.6 and 3.7 on any Unix-like\nplatform."}),"\n",(0,r.jsx)(n.h2,{id:"install-via-pip",children:"Install via pip"}),"\n",(0,r.jsx)(n.p,{children:"Heads up: We recommend to use the docker-based install (see next\nsection) as it will configure many things for you automatically. Only\nuse the pip-based install if you have a good reason and know how to\nconfigure your web service manually:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"pip install rucio\n"})}),"\n",(0,r.jsxs)(n.p,{children:["This will pull the latest release from\n",(0,r.jsx)(n.a,{href:"https://pypi.python.org/pypi/rucio/",children:(0,r.jsx)(n.strong,{children:"PyPi"})}),". The Rucio server also needs\nseveral Python dependencies. These are all listed in the file\n",(0,r.jsx)(n.a,{href:"https://github.com/rucio/rucio/blob/master/requirements/requirements.server.txt",children:(0,r.jsx)(n.code,{children:"requirements.server.txt"})}),"\nand will be pulled in as necessary."]}),"\n",(0,r.jsx)(n.h2,{id:"install-via-docker",children:"Install via Docker"}),"\n",(0,r.jsx)(n.p,{children:"This image provides the Rucio daemons. Each daemon has to be run in a\nseparate container. It supports MySQL, PostgreSQL, Oracle, and SQLite as\ndatabase backends."}),"\n",(0,r.jsxs)(n.p,{children:["This image expects that there is an already initialised Rucio DB. To\nstart a simple ",(0,r.jsx)(n.code,{children:"judge-cleaner"})," daemon using a database on\n",(0,r.jsx)(n.code,{children:"mysql.db"})," without any additional parameters just run this:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'docker run --name=rucio-judge-cleaner \\\n -e RUCIO_CFG_DATABASE_DEFAULT="mysql+pymysql://rucio:rucio@mysql.db/rucio" \\\n -e RUCIO_DAEMON=judge-cleaner \\\n rucio/rucio-daemons\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"RUCIO_DAEMON"})," environment variable gives the name of\nthe rucio daemon."]}),"\n",(0,r.jsxs)(n.p,{children:["Rucio can be configured fully using environment variables like\n",(0,r.jsx)(n.code,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),". If you want to instead use a\ncomplete rucio.cfg it can also be mounted. This will then ignore the\n",(0,r.jsx)(n.code,{children:"RUCIO_CFG"})," environment variables:"]}),"\n",(0,r.jsx)(n.p,{children:"The rucio.cfg is used to configure the database backend and the daemons:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --name=rucio-judge-cleaner \\\n -v /tmp/rucio.cfg:/opt/rucio/etc/rucio.cfg \\\n -e RUCIO_DAEMON=judge-cleaner \\\n rucio/rucio-daemons\n"})}),"\n",(0,r.jsxs)(n.p,{children:["By default the daemon logs are written to stdout and stderr if you want\nto write to a file you can use ",(0,r.jsx)(n.code,{children:"RUCIO_ENABLE_LOGS"})," like\nthis:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"docker run --name=rucio-judge-cleaner \\\n -v /tmp/rucio.cfg:/opt/rucio/etc/rucio.cfg \\\n -v /tmp/logs:/var/log/rucio -e RUCIO_DAEMON=judge-cleaner \\\n -e RUCIO_ENABLE_LOGS=True \\\n rucio/rucio-daemons\n"})}),"\n",(0,r.jsx)(n.h2,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,r.jsxs)(n.p,{children:["As shown in the examples above the rucio-daemon image can be configured\nusing environment variables that are passed with ",(0,r.jsx)(n.code,{children:"docker run"}),".\nBelow is a list of all available variables and their behaviour:"]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_daemon",children:"RUCIO_DAEMON"}),"\n",(0,r.jsxs)(n.p,{children:["This variable is mandatory and it specifies the name of the daemon,\ne.g., ",(0,r.jsx)(n.code,{children:"hermes"}),", ",(0,r.jsx)(n.code,{children:"kronos"}),",\n",(0,r.jsx)(n.code,{children:"judge-evaluator"}),", etc."]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_daemon_args",children:"RUCIO_DAEMON_ARGS"}),"\n",(0,r.jsxs)(n.p,{children:["Any additional command line parameter can be specified here, e.g.,\n",(0,r.jsx)(n.code,{children:"\\--run-once"})," This field is optional."]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_enable_logs",children:"RUCIO_ENABLE_LOGS"}),"\n",(0,r.jsxs)(n.p,{children:["By default, the log output of the daemon is written to stdout and\nstderr. If you set this variable to ",(0,r.jsx)(n.code,{children:"True"})," the output will\nbe written to ",(0,r.jsx)(n.code,{children:"access_log"})," and ",(0,r.jsx)(n.code,{children:"error_log"})," under\n",(0,r.jsx)(n.code,{children:"/var/log/rucio"})]}),"\n",(0,r.jsx)(n.h3,{id:"rucio_cfg-configuration-parameters",children:"RUCIO_CFG configuration parameters"}),"\n",(0,r.jsxs)(n.p,{children:["Environment variables can be used to set values for the auto-generated\nrucio.cfg. The names are derived from the actual names in the\nconfiguration file prefixed by ",(0,r.jsx)(n.code,{children:"RUCIO_CFG"}),", e.g., the\n",(0,r.jsx)(n.code,{children:"default"})," value in the ",(0,r.jsx)(n.code,{children:"database"})," section\nbecomes ",(0,r.jsx)(n.code,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),". All available\nenvironment variables are:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_ACCOUNTS_SPECIAL_ACCOUNTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_LOGDIR"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_LOGLEVEL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_COMMON_MAILTEMPLATEDIR"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_DEFAULT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_RESET_ON_RETURN"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_ECHO"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_RECYCLE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_SIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POOL_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_MAX_OVERFLOW"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POWUSERACCOUNT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_DATABASE_POWUSERPASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_CARBON_SERVER"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_CARBON_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MONITOR_USER_SCOPE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_POLICY"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SCHEMA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_LFN2PFN_ALGORITHM_DEFAULT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SUPPORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_PERMISSION_SUPPORT_RUCIO"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SITES"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SLEEP_TIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_DATASET_LIFETIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUTOMATIX_SET_METADATA"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUDITOR_RESULTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_AUDITOR_CACHE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_SCHEME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_TRANSFERTOOL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_FTSHOSTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_CACERT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USERCERT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_CACHE_TIME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USE_DETERMINISTIC_ID"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_POLL_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_SUBMIT_TIMEOUT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_BRING_ONLINE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_QUEUE_MODE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_USING_MEMCACHE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CONVEYOR_FTSMONHOSTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_FTS3_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_USERNAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_PASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_NONSSL_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_USE_SSL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_EMAIL_FROM"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_HERMES_EMAIL_TEST"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_QUEUE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_PREFETCH_SIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_CHUNKSIZE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_SUBSCRIPTION_ID"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_USE_SSL"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_RECONNECT_ATTEMPTS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_EXCLUDED_USRDNS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_USERNAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_KRONOS_PASSWORD"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_TRACER_DATASET_WAIT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_PORT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_SSL_KEY_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_SSL_CERT_FILE"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_DESTINATION"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_BROKERS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_VONAME"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_MESSAGING_CACHE_ACCOUNT"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CREDENTIALS_GCS"}),"\n",(0,r.jsx)(n.li,{children:"RUCIO_CFG_CREDENTIALS_SIGNATURE_LIFETIME"}),"\n"]})]})}function t(e={}){const{wrapper:n}={...(0,_.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var l=i(96540);const r={},_=l.createContext(r);function s(e){const n=l.useContext(_);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),l.createElement(_.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3e04ff1b.bb1dab66.js b/assets/js/3e04ff1b.bb1dab66.js deleted file mode 100644 index 7238da7319..0000000000 --- a/assets/js/3e04ff1b.bb1dab66.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[586],{10470:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"started/concepts/replica_management","title":"Replica management with replication rules","description":"Replica management is based on replication rules defined on data identifiers","source":"@site/../docs/started/concepts/replica_management.md","sourceDirName":"started/concepts","slug":"/started/concepts/replica_management","permalink":"/documentation/started/concepts/replica_management","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/replica_management.md","tags":[],"version":"current","lastUpdatedBy":"Martin Barisits","lastUpdatedAt":1732611614000,"frontMatter":{"title":"Replica management with replication rules"},"sidebar":"docs","previous":{"title":"Permission model","permalink":"/documentation/started/concepts/permission_model"},"next":{"title":"Replication rule examples","permalink":"/documentation/started/concepts/replication_rules_examples"}}');var s=n(74848),r=n(28453);const l={title:"Replica management with replication rules"},a=void 0,o={},d=[{value:"Rule grouping and replica storage",id:"rule-grouping-and-replica-storage",level:2},{value:"Footnotes",id:"footnotes",level:2}];function c(e){const t={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",section:"section",strong:"strong",sup:"sup",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Replica management is based on replication rules defined on data identifiers\n(files, datasets, containers). A replication rule is owned by an account and\ndefines the minimum number of replicas to be available on a list of RSEs,\ndenoted by an ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/rse_expressions",children:"RSE Expression"}),". Accounts are allowed to set\nmultiple rules",(0,s.jsx)(t.sup,{children:(0,s.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})}),". Rules may optionally have a limited lifetime and can be\nadded, removed or modified at any time."]}),"\n",(0,s.jsx)(t.p,{children:"An example listing of replication rules is given below:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"prod: 1x replica @ CERN, no lifetime"}),"\n",(0,s.jsx)(t.li,{children:"barisits: 1x replica @ US-T2, until 2019-01-01"}),"\n",(0,s.jsx)(t.li,{children:"vgaronne: 2x replica @ T1, no lifetime"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"A rule engine validates the rules and creates transfer primitives to fulfil all\nrules, e.g. transfer a file from RSE A to RSE B. The rule engine is triggered\nwhen a new rule is defined on an existing data identifier, or when a file is\nadded to a dataset with existing rules. The rule engine will only create the\nminimum set of necessary transfer primitives to satisfy all rules."}),"\n",(0,s.jsx)(t.p,{children:"Notifications can be provided for rules and their underlying transfer\nrequests. All transfer requests are transient."}),"\n",(0,s.jsx)(t.p,{children:"The deletion service supports two different modes: greedy and non-greedy. Greedy\nmeans that the service tries to immediately delete all replicas which are not\nprotected by a replication rule. Non-greedy deletion is triggered when storage\npolicy dictates that space must be freed. The deletion service will look for\nreplicas on that RSE which can be deleted without violating any replication\nrule. The deletion service will use a Least Recently Used (LRU) algorithm to\nselect replicas for deletion. The deletion service will also immediately delete\nall replicas of any file which is declared obsolete."}),"\n",(0,s.jsxs)(t.p,{children:["Some examples of replication rules are listed\n",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/replication_rules_examples",children:"here"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"rule-grouping-and-replica-storage",children:"Rule grouping and replica storage"}),"\n",(0,s.jsx)(t.p,{children:"The following two parameters determine the way the files to be replicated\nare assigned to suitable RSEs:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["The ",(0,s.jsx)(t.strong,{children:"rule grouping"}),": ",(0,s.jsx)(t.code,{children:"ALL"}),", ",(0,s.jsx)(t.code,{children:"DATASET"}),", ",(0,s.jsx)(t.code,{children:"NONE"}),"."]}),"\n",(0,s.jsxs)(t.li,{children:["The ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/file_dataset_container",children:"DID type"}),": ",(0,s.jsx)(t.code,{children:"FILE"}),", ",(0,s.jsx)(t.code,{children:"DATASET"}),", ",(0,s.jsx)(t.code,{children:"CONTAINER"}),"."]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The table below describes the resulting replication logic\ndepending on the combination of rule grouping (header row) and DID type (left column)."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"ALL"})}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"DATASET"})}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"NONE"})})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"FILE"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"N/A"}),(0,s.jsx)(t.td,{children:"No restrictions"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"DATASET"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"N/A"}),(0,s.jsx)(t.td,{children:"No restrictions"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"CONTAINER"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"All files in a dataset must be on the same RSE, but different datasets can be on different RSEs"}),(0,s.jsx)(t.td,{children:"No restrictions"})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"footnotes",children:"Footnotes"}),"\n","\n",(0,s.jsxs)(t.section,{"data-footnotes":!0,className:"footnotes",children:[(0,s.jsx)(t.h2,{className:"sr-only",id:"footnote-label",children:"Footnotes"}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{id:"user-content-fn-1",children:["\n",(0,s.jsxs)(t.p,{children:["The system may reject rules if these violate other policies, e.g., only\nspecific accounts are allowed to request replication rules for tape systems. ",(0,s.jsx)(t.a,{href:"#user-content-fnref-1","data-footnote-backref":"","aria-label":"Back to reference 1",className:"data-footnote-backref",children:"\u21a9"})]}),"\n"]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>a});var i=n(96540);const s={},r=i.createContext(s);function l(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3e04ff1b.c13e40df.js b/assets/js/3e04ff1b.c13e40df.js new file mode 100644 index 0000000000..9faad823aa --- /dev/null +++ b/assets/js/3e04ff1b.c13e40df.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[586],{10470:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"started/concepts/replica_management","title":"Replica management with replication rules","description":"Replica management is based on replication rules defined on data identifiers","source":"@site/../docs/started/concepts/replica_management.md","sourceDirName":"started/concepts","slug":"/started/concepts/replica_management","permalink":"/documentation/started/concepts/replica_management","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/started/concepts/replica_management.md","tags":[],"version":"current","lastUpdatedBy":"voetberg","lastUpdatedAt":1732720411000,"frontMatter":{"title":"Replica management with replication rules"},"sidebar":"docs","previous":{"title":"Permission model","permalink":"/documentation/started/concepts/permission_model"},"next":{"title":"Replication rule examples","permalink":"/documentation/started/concepts/replication_rules_examples"}}');var s=n(74848),r=n(28453);const l={title:"Replica management with replication rules"},o=void 0,a={},d=[{value:"Rule grouping and replica storage",id:"rule-grouping-and-replica-storage",level:2},{value:"Footnotes",id:"footnotes",level:2}];function c(e){const t={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",section:"section",strong:"strong",sup:"sup",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Replica management is based on replication rules defined on data identifiers\n(files, datasets, containers). A replication rule is owned by an account and\ndefines the minimum number of replicas to be available on a list of RSEs,\ndenoted by an ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/rse_expressions",children:"RSE Expression"}),". Accounts are allowed to set\nmultiple rules",(0,s.jsx)(t.sup,{children:(0,s.jsx)(t.a,{href:"#user-content-fn-1",id:"user-content-fnref-1","data-footnote-ref":!0,"aria-describedby":"footnote-label",children:"1"})}),". Rules may optionally have a limited lifetime and can be\nadded, removed or modified at any time."]}),"\n",(0,s.jsx)(t.p,{children:"An example listing of replication rules is given below:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"prod: 1x replica @ CERN, no lifetime"}),"\n",(0,s.jsx)(t.li,{children:"barisits: 1x replica @ US-T2, until 2019-01-01"}),"\n",(0,s.jsx)(t.li,{children:"vgaronne: 2x replica @ T1, no lifetime"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"A rule engine validates the rules and creates transfer primitives to fulfil all\nrules, e.g. transfer a file from RSE A to RSE B. The rule engine is triggered\nwhen a new rule is defined on an existing data identifier, or when a file is\nadded to a dataset with existing rules. The rule engine will only create the\nminimum set of necessary transfer primitives to satisfy all rules."}),"\n",(0,s.jsx)(t.p,{children:"Notifications can be provided for rules and their underlying transfer\nrequests. All transfer requests are transient."}),"\n",(0,s.jsx)(t.p,{children:"The deletion service supports two different modes: greedy and non-greedy. Greedy\nmeans that the service tries to immediately delete all replicas which are not\nprotected by a replication rule. Non-greedy deletion is triggered when storage\npolicy dictates that space must be freed. The deletion service will look for\nreplicas on that RSE which can be deleted without violating any replication\nrule. The deletion service will use a Least Recently Used (LRU) algorithm to\nselect replicas for deletion. The deletion service will also immediately delete\nall replicas of any file which is declared obsolete."}),"\n",(0,s.jsxs)(t.p,{children:["Some examples of replication rules are listed\n",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/replication_rules_examples",children:"here"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"rule-grouping-and-replica-storage",children:"Rule grouping and replica storage"}),"\n",(0,s.jsx)(t.p,{children:"The following two parameters determine the way the files to be replicated\nare assigned to suitable RSEs:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["The ",(0,s.jsx)(t.strong,{children:"rule grouping"}),": ",(0,s.jsx)(t.code,{children:"ALL"}),", ",(0,s.jsx)(t.code,{children:"DATASET"}),", ",(0,s.jsx)(t.code,{children:"NONE"}),"."]}),"\n",(0,s.jsxs)(t.li,{children:["The ",(0,s.jsx)(t.a,{href:"/documentation/started/concepts/file_dataset_container",children:"DID type"}),": ",(0,s.jsx)(t.code,{children:"FILE"}),", ",(0,s.jsx)(t.code,{children:"DATASET"}),", ",(0,s.jsx)(t.code,{children:"CONTAINER"}),"."]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"The table below describes the resulting replication logic\ndepending on the combination of rule grouping (header row) and DID type (left column)."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"ALL"})}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"DATASET"})}),(0,s.jsx)(t.th,{children:(0,s.jsx)(t.strong,{children:"NONE"})})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"FILE"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"N/A"}),(0,s.jsx)(t.td,{children:"No restrictions"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"DATASET"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"N/A"}),(0,s.jsx)(t.td,{children:"No restrictions"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:(0,s.jsx)(t.strong,{children:"CONTAINER"})}),(0,s.jsx)(t.td,{children:"All files must be on the same RSE"}),(0,s.jsx)(t.td,{children:"All files in a dataset must be on the same RSE, but different datasets can be on different RSEs"}),(0,s.jsx)(t.td,{children:"No restrictions"})]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"footnotes",children:"Footnotes"}),"\n","\n",(0,s.jsxs)(t.section,{"data-footnotes":!0,className:"footnotes",children:[(0,s.jsx)(t.h2,{className:"sr-only",id:"footnote-label",children:"Footnotes"}),"\n",(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{id:"user-content-fn-1",children:["\n",(0,s.jsxs)(t.p,{children:["The system may reject rules if these violate other policies, e.g., only\nspecific accounts are allowed to request replication rules for tape systems. ",(0,s.jsx)(t.a,{href:"#user-content-fnref-1","data-footnote-backref":"","aria-label":"Back to reference 1",className:"data-footnote-backref",children:"\u21a9"})]}),"\n"]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>o});var i=n(96540);const s={},r=i.createContext(s);function l(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/409bbd92.dc739ba3.js b/assets/js/409bbd92.dc739ba3.js deleted file mode 100644 index 3358a0ce14..0000000000 --- a/assets/js/409bbd92.dc739ba3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[505],{96358:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"client_api/diracclient","title":"DiracClient","description":"add\\\\_files","source":"@site/../docs/client_api/diracclient.md","sourceDirName":"client_api","slug":"/client_api/diracclient","permalink":"/documentation/client_api/diracclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/diracclient.md","tags":[],"version":"current","frontMatter":{"title":"DiracClient"},"sidebar":"docs","previous":{"title":"DIDClient","permalink":"/documentation/client_api/didclient"},"next":{"title":"DownloadClient","permalink":"/documentation/client_api/downloadclient"}}');var l=n(74848),r=n(28453);const s={title:"DiracClient"},c=void 0,o={},a=[{value:"add_files",id:"add_files",level:2}];function d(e){const t={code:"code",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.h2,{id:"add_files",children:"add_files"}),"\n",(0,l.jsxs)("span",{style:{"white-space":"pre"},children:[(0,l.jsx)(t.p,{children:"Bulk add files :"}),(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsx)(t.li,{children:"Create the file and replica."}),"\n",(0,l.jsx)(t.li,{children:"If doesn't exist create the dataset containing the file as well as a rule on the dataset on ANY sites."}),"\n",(0,l.jsx)(t.li,{children:"Create all the ascendants of the dataset if they do not exist"}),"\n"]}),(0,l.jsx)("table",{style:{border:"none"},children:(0,l.jsx)("tbody",{children:(0,l.jsxs)("tr",{style:{border:"none"},children:[(0,l.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.strong,{children:"Arguments"}),":"]})}),(0,l.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.code,{children:"lfns"}),": List of lfn (dictionary {'lfn': , 'rse': , 'bytes': , 'adler32': , 'guid': , 'pfn': }"]}),(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.code,{children:"ignore_availability"}),": A boolean to ignore blocked sites."]}),(0,l.jsxs)(t.p,{children:[(0,l.jsx)(t.code,{children:"parents_metadata"}),": Metadata for selected hierarchy DIDs. (dictionary {'lpn': {key : value}}). Default=None"]})]})]})})})]})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var i=n(96540);const l={},r=i.createContext(l);function s(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/419565ab.5b10b17c.js b/assets/js/419565ab.5b10b17c.js deleted file mode 100644 index 388a57a47b..0000000000 --- a/assets/js/419565ab.5b10b17c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[2118],{17849:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"client_api/configclient","title":"ConfigClient","description":"get\\\\_config","source":"@site/../docs/client_api/configclient.md","sourceDirName":"client_api","slug":"/client_api/configclient","permalink":"/documentation/client_api/configclient","draft":false,"unlisted":false,"editUrl":"https://github.com/rucio/documentation/tree/main/docs/../docs/client_api/configclient.md","tags":[],"version":"current","frontMatter":{"title":"ConfigClient"},"sidebar":"docs","previous":{"title":"Client","permalink":"/documentation/client_api/client"},"next":{"title":"CredentialClient","permalink":"/documentation/client_api/credentialclient"}}');var r=o(74848),i=o(28453);const s={title:"ConfigClient"},c=void 0,l={},d=[{value:"get_config",id:"get_config",level:2},{value:"set_config_option",id:"set_config_option",level:2},{value:"delete_config_option",id:"delete_config_option",level:2}];function a(e){const n={code:"code",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"get_config",children:"get_config"}),"\n",(0,r.jsxs)("span",{style:{"white-space":"pre"},children:[(0,r.jsx)(n.p,{children:"Sends the request to get the matching configuration."}),(0,r.jsx)("table",{style:{border:"none"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{style:{border:"none"},children:[(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,r.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"section"}),": the optional name of the section."]}),(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"option"}),": the optional option within the section."]})]})]}),(0,r.jsxs)("tr",{style:{border:"none"},children:[(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Returns"}),":"]})}),(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsx)(n.p,{children:"dictionary containing the configuration."})})]})]})})]}),"\n",(0,r.jsx)(n.h2,{id:"set_config_option",children:"set_config_option"}),"\n",(0,r.jsxs)("span",{style:{"white-space":"pre"},children:[(0,r.jsx)(n.p,{children:"Sends the request to create or set an option within a section. Missing sections will be created."}),(0,r.jsx)("table",{style:{border:"none"},children:(0,r.jsxs)("tbody",{children:[(0,r.jsxs)("tr",{style:{border:"none"},children:[(0,r.jsx)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Arguments"}),":"]})}),(0,r.jsxs)("td",{style:{border:"none",backgroundColor:"var(--ifm-background-color)",verticalAlign:"top"},children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"section"}),": the name of the section."]}),(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"option"}),": the name of the option."]}),(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"value"}),": the value to set on the config option"]}),(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"use_body_for_params"}),': send parameters in a json-encoded request body instead of url-encoded\nTODO: remove this parameter\nThe format of the /config endpoint was recently changed. We migrated from performing a PUT on\n"/config/
    /

    Arguments:

    account: the name of the account.

    type_: The account type

    email: The Email address associated with the account.

    Raises:

    Duplicate: if account already exists.

    Returns:

    True if account was created successfully else False.

    -

    delete_account​

    -

    Sends the request to disable an account.

    Arguments:

    account: the name of the account.

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    True is account was disabled successfully. False otherwise.

     -

    get_account​

    -

    Sends the request to get information about a given account.

    Arguments:

    account: the name of the account.

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    a list of attributes for the account. None if failure.

     -

    update_account​

    -

    Update a property of an account.

    Arguments:

    account: Name of the account.

    key: Account property like status.

    value: Property value.

     -

    list_accounts​

    -

    Sends the request to list all rucio accounts.

    Arguments:

    type: The account type

    identity: The identity key name. For example x509 DN, or a username.

    filters: A dictionary key:account attribute to use for the filtering

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    a list containing account info dictionary for all rucio accounts.

     -

    whoami​

    -

    Get information about account whose token is used

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    a list of attributes for the account. None if failure.

     -

    add_identity​

    -

    Adds a membership association between identity and account.

    Arguments:

    account: The account name.

    identity: The identity key name. For example x509 DN, or a username.

    authtype: The type of the authentication (x509, gss, userpass).

    default: If True, the account should be used by default with the provided identity.

    email: The Email address associated with the identity.

    password: Password if authtype is userpass.

     -

    del_identity​

    -

    Delete an identity's membership association with an account.

    Arguments:

    account: The account name.

    identity: The identity key name. For example x509 DN, or a username.

    authtype: The type of the authentication (x509, gss, userpass).

    default: If True, the account should be used by default with the provided identity.

     -

    list_identities​

    -

    List all identities on an account.

    Arguments:

    account: The account name.

     -

    list_account_rules​

    -

    List the associated rules of an account.

    Arguments:

    account: The account name.

     -

    get_account_limits​

    -

    Return the correct account limits for the given locality.

    Arguments:

    account: The account name.

    rse_expression: Valid RSE expression

    locality: The scope of the account limit. 'local' or 'global'.

     -

    get_global_account_limit​

    -

    List the account limit for the specific RSE expression.

    Arguments:

    account: The account name.

    rse_expression: The rse expression.

     -

    get_global_account_limits​

    -

    List all RSE expression limits of this account.

    Arguments:

    account: The account name.

     -

    get_local_account_limits​

    -

    List the account rse limits of this account.

    Arguments:

    account: The account name.

     -

    get_local_account_limit​

    -

    List the account rse limits of this account for the specific rse.

    Arguments:

    account: The account name.

    rse: The rse name.

     -

    get_local_account_usage​

    -

    List the account usage for one or all rses of this account.

    Arguments:

    account: The account name.

    rse: The rse name.

     -

    get_global_account_usage​

    -

    List the account usage for one or all RSE expressions of this account.

    Arguments:

    account: The account name.

    rse_expression: The rse expression.

     -

    get_account_usage_history​

    -

    List the account usage history of this account on rse.

    Arguments:

    account: The account name.

    rse: The rse name.

     -

    list_account_attributes​

    -

    List the attributes for an account.

    Arguments:

    account: The account name.

     -

    add_account_attribute​

    -

    Adds an attribute to an account.

    Arguments:

    account: The account name.

    key: The attribute key.

    value: The attribute value.

     -

    delete_account_attribute​

    -

    Delete an attribute for an account.

    Arguments:

    account: The account name.

    key: The attribute key.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/accountlimitclient/index.html b/client_api/accountlimitclient/index.html deleted file mode 100644 index cddc23822c..0000000000 --- a/client_api/accountlimitclient/index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - -AccountLimitClient | Rucio Documentation - - - - - - - - - -

    AccountLimitClient

    set_account_limit​

    -

    Sets an account limit for a given limit scope.

    Arguments:

    account: The name of the account.

    rse: The rse name.

    bytes_: An integer with the limit in bytes.

    locality: The scope of the account limit. 'local' or 'global'.

    Returns:

    True if quota was created successfully else False.

     -

    delete_account_limit​

    -

    Deletes an account limit for a given limit scope.

    Arguments:

    account: The name of the account.

    rse: The rse name.

    locality: The scope of the account limit. 'local' or 'global'.

    Returns:

    True if quota was created successfully else False.

     -

    set_local_account_limit​

    -

    Sends the request to set an account limit for an account.

    Arguments:

    account: The name of the account.

    rse: The rse name.

    bytes_: An integer with the limit in bytes.

    Returns:

    True if quota was created successfully else False.

     -

    delete_local_account_limit​

    -

    Sends the request to remove an account limit.

    Arguments:

    account: The name of the account.

    rse: The rse name.

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    True if quota was removed successfully. False otherwise.

     -

    set_global_account_limit​

    -

    Sends the request to set a global account limit for an account.

    Arguments:

    account: The name of the account.

    rse_expression: The rse expression.

    bytes_: An integer with the limit in bytes.

    Returns:

    True if quota was created successfully else False.

     -

    delete_global_account_limit​

    -

    Sends the request to remove a global account limit.

    Arguments:

    account: The name of the account.

    rse_expression: The rse expression.

    Raises:

    AccountNotFound: if account doesn't exist.

    Returns:

    True if quota was removed successfully. False otherwise.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/baseclient/index.html b/client_api/baseclient/index.html deleted file mode 100644 index ddf9bf6d98..0000000000 --- a/client_api/baseclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -BaseClient | Rucio Documentation - - - - - - - - - -

    BaseClient

    __init__​

    -

    Constructor of the BaseClient.

    Arguments:

    rucio_host: The address of the rucio server, if None it is read from the config file.

    rucio_port: The port of the rucio server, if None it is read from the config file.

    auth_host: The address of the rucio authentication server, if None it is read from the config file.

    auth_port: The port of the rucio authentication server, if None it is read from the config file.

    account: The account to authenticate to rucio.

    use_ssl: Enable or disable ssl for commucation. Default is enabled.

    ca_cert: The path to the rucio server certificate.

    auth_type: The type of authentication (e.g.: 'userpass', 'kerberos' ...)

    creds: Dictionary with credentials needed for authentication.

    user_agent: Indicates the client.

    vo: The VO to authenticate into.

    logger: Logger object to use. If None, use the default LOG created by the module

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/client/index.html b/client_api/client/index.html deleted file mode 100644 index 48175b15da..0000000000 --- a/client_api/client/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -Client | Rucio Documentation - - - - - - - - - -

    Client

    __init__​

    -

    Constructor for the Rucio main client class.

    Arguments:

    rucio_host: the host of the rucio system.

    auth_host: the host of the rucio authentication server.

    account: the rucio account that should be used to interact with the rucio system.

    ca_cert: the certificate to verify the server.

    auth_type: the type of authentication to use (e.g. userpass, x509 ...)

    creds: credentials needed for authentication.

    timeout: Float describes the timeout of the request (in seconds).

    vo: The vo that the client will interact with.

    logger: Logger instance to use (optional)

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/configclient/index.html b/client_api/configclient/index.html deleted file mode 100644 index d71df1d851..0000000000 --- a/client_api/configclient/index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - -ConfigClient | Rucio Documentation - - - - - - - - - -

    ConfigClient

    get_config​

    -

    Sends the request to get the matching configuration.

    Arguments:

    section: the optional name of the section.

    option: the optional option within the section.

    Returns:

    dictionary containing the configuration.

     -

    set_config_option​

    -

    Sends the request to create or set an option within a section. Missing sections will be created.

    Arguments:

    section: the name of the section.

    option: the name of the option.

    value: the value to set on the config option

    use_body_for_params: send parameters in a json-encoded request body instead of url-encoded -TODO: remove this parameter -The format of the /config endpoint was recently changed. We migrated from performing a PUT on -"/config/<section>/<option>/<value>" to sending the parameters using a json-encoded body. -This was done to fix multiple un-wanted side effects related to how the middleware treats -values encoded in a path. -For a smooth transition, we allow both cases for now, but we should migrate to only passing -values via the request body.

    Returns:

    True if option was removed successfully. False otherwise.

     -

    delete_config_option​

    -

    Sends the request to remove an option from a section

    Arguments:

    section: the name of the section.

    option: the name of the option.

    Returns:

    True if option was removed successfully. False otherwise.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/credentialclient/index.html b/client_api/credentialclient/index.html deleted file mode 100644 index 2a93e3fbc9..0000000000 --- a/client_api/credentialclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -CredentialClient | Rucio Documentation - - - - - - - - - -

    CredentialClient

    get_signed_url​

    -

    Return a signed version of the given URL for the given operation.

    Arguments:

    rse: The name of the RSE the URL points to.

    service: The service the URL points to (gcs, s3, swift)

    operation: The desired operation (read, write, delete)

    url: The URL to sign

    lifetime: The desired lifetime of the URL in seconds

    Returns:

    The signed URL string

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/didclient/index.html b/client_api/didclient/index.html deleted file mode 100644 index 989433ad13..0000000000 --- a/client_api/didclient/index.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -DIDClient | Rucio Documentation - - - - - - - - - -

    DIDClient

    list_dids​

    -

    List all data identifiers in a scope which match a given pattern.

    Arguments:

    scope: The scope name.

    filters: A nested dictionary of key/value pairs like [{'key1': 'value1', 'key2.lte': 'value2'}, {'key3.gte, 'value3'}]. -Keypairs in the same dictionary are AND'ed together, dictionaries are OR'ed together. Keys should be suffixed -like <key>.<operation>, e.g. key1 >= value1 is equivalent to {'key1.gte': value}, where <operation> belongs to one -of the set {'lte', 'gte', 'gt', 'lt', 'ne' or ''}. Equivalence doesn't require an operator.

    did_type: The type of the did: 'all'(container, dataset or file)|'collection'(dataset or container)|'dataset'|'container'|'file'

    long: Long format option to display more information for each DID.

    recursive: Recursively list DIDs content.

     -

    list_dids_extended​

    -

    List all data identifiers in a scope which match a given pattern (DEPRECATED)

     -

    add_did​

    -

    Add data identifier for a dataset or container.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    did_type: The data identifier type (dataset|container).

    statuses: Dictionary with statuses, e.g. {'monotonic':True}.

    meta: Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

    rules: Replication rules associated with the data identifier. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].

    lifetime: DID's lifetime (in seconds).

    dids: The content.

    rse: The RSE name when registering replicas.

     -

    add_dids​

    -

    Bulk add datasets/containers.

     -

    add_dataset​

    -

    Add data identifier for a dataset.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    statuses: Dictionary with statuses, e.g.g {'monotonic':True}.

    meta: Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

    rules: Replication rules associated with the data identifier. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].

    lifetime: DID's lifetime (in seconds).

    files: The content.

    rse: The RSE name when registering replicas.

     -

    add_datasets​

    -

    Bulk add datasets.

    Arguments:

    dsns: A list of datasets.

     -

    add_container​

    -

    Add data identifier for a container.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    statuses: Dictionary with statuses, e.g.g {'monotonic':True}.

    meta: Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

    rules: Replication rules associated with the data identifier. A list of dictionaries, e.g., [{'copies': 2, 'rse_expression': 'TIERS1'}, ].

    lifetime: DID's lifetime (in seconds).

     -

    add_containers​

    -

    Bulk add containers.

    Arguments:

    cnts: A list of containers.

     -

    attach_dids​

    -

    Attach data identifier.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    dids: The content.

    rse: The RSE name when registering replicas.

     -

    detach_dids​

    -

    Detach data identifier

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    dids: The content.

     -

    attach_dids_to_dids​

    -

    Add dids to dids.

    Arguments:

    attachments: The attachments. -attachments is: [attachment, attachment, ...] -attachment is: {'scope': scope, 'name': name, 'dids': dids} -dids is: [{'scope': scope, 'name': name}, ...]

    ignore_duplicate: If True, ignore duplicate entries.

     -

    add_files_to_datasets​

    -

    Add files to datasets.

    Arguments:

    attachments: The attachments. -attachments is: [attachment, attachment, ...] -attachment is: {'scope': scope, 'name': name, 'dids': dids} -dids is: [{'scope': scope, 'name': name}, ...]

    ignore_duplicate: If True, ignore duplicate entries.

     -

    add_datasets_to_containers​

    -

    Add datasets_to_containers.

    Arguments:

    attachments: The attachments. -attachments is: [attachment, attachment, ...] -attachment is: {'scope': scope, 'name': name, 'dids': dids} -dids is: [{'scope': scope, 'name': name}, ...]

     -

    add_containers_to_containers​

    -

    Add containers_to_containers.

    Arguments:

    attachments: The attachments. -attachments is: [attachment, attachment, ...] -attachment is: {'scope': scope, 'name': name, 'dids': dids} -dids is: [{'scope': scope, 'name': name}, ...]

     -

    add_files_to_dataset​

    -

    Add files to datasets.

    Arguments:

    scope: The scope name.

    name: The dataset name.

    files: The content.

    rse: The RSE name when registering replicas.

     -

    add_files_to_archive​

    -

    Add files to archive.

    Arguments:

    scope: The scope name.

    name: The dataset name.

    files: The content.

     -

    add_datasets_to_container​

    -

    Add datasets to container.

    Arguments:

    scope: The scope name.

    name: The dataset name.

    dsns: The content.

     -

    add_containers_to_container​

    -

    Add containers to container.

    Arguments:

    scope: The scope name.

    name: The dataset name.

    cnts: The content.

     -

    list_content​

    -

    List data identifier contents.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

     -

    list_content_history​

    -

    List data identifier contents history.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

     -

    list_files​

    -

    List data identifier file contents.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    long: A boolean to choose if GUID is returned or not.

     -

    bulk_list_files​

    -

    List data identifier file contents.

    Arguments:

    dids: The list of DIDs.

     -

    get_did​

    -

    Retrieve a single data identifier.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    dynamic_depth: The DID type as string ('FILE'/'DATASET') at which to stop the dynamic -length/bytes calculation. If not set, the size will not be computed dynamically.

    dynamic: (Deprecated) same as dynamic_depth = 'FILE'

     -

    get_metadata​

    -

    Get data identifier metadata

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    plugin: Backend Metadata plugin the Rucio server should use to query data.

     -

    get_metadata_bulk​

    -

    Bulk get data identifier metadata

    Arguments:

    inherit: A boolean. If set to true, the metadata of the parent are concatenated.

    dids: A list of dids.

     -

    set_metadata​

    -

    Set data identifier metadata

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    key: the key.

    value: the value.

    recursive: Option to propagate the metadata change to content.

     -

    set_metadata_bulk​

    -

    Set data identifier metadata in bulk.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    meta: the metadata key-values.

    recursive: Option to propagate the metadata change to content.

     -

    set_dids_metadata_bulk​

    -

    Set metadata to a list of data identifiers.

    Arguments:

    dids: A list of dids including metadata, i.e. [{'scope': scope1, 'name': name1, 'meta': {key1: value1, key2: value2}] .

    recursive: Option to propagate the metadata update to content.

     -

    set_status​

    -

    Set data identifier status

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    kwargs: Keyword arguments of the form status_name=value.

     -

    close​

    -

    close dataset/container

    Arguments:

    scope: The scope name.

    name: The dataset/container name.

     -

    delete_metadata​

    -

    Delete data identifier metadata

    Arguments:

    scope: The scope name.

    name: The data identifier.

    key: the key.

     -

    list_did_rules​

    -

    List the associated rules of a data identifier.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

     -

    list_associated_rules_for_file​

    -

    List the associated rules a file is affected from..

    Arguments:

    scope: The scope name.

    name: The file name.

     -

    get_dataset_by_guid​

    -

    Get the parent datasets for a given GUID.

    Arguments:

    guid: The GUID.

    Returns:

    A did

     -

    scope_list​

    -

    List data identifiers in a scope.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    recursive: boolean, True or False.

     -

    list_parent_dids​

    -

    List parent dataset/containers of a did.

    Arguments:

    scope: The scope.

    name: The name.

     -

    create_did_sample​

    -

    Create a sample from an input collection.

    Arguments:

    input_scope: The scope of the input DID.

    input_name: The name of the input DID.

    output_scope: The scope of the output dataset.

    output_name: The name of the output dataset.

    account: The account.

    nbfiles: The number of files to register in the output dataset.

     -

    resurrect​

    -

    Resurrect a list of dids.

    Arguments:

    dids: A list of dids [{'scope': scope, 'name': name}, ...]

     -

    list_archive_content​

    -

    List archive contents.

    Arguments:

    scope: The scope name.

    name: The data identifier name.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/diracclient/index.html b/client_api/diracclient/index.html deleted file mode 100644 index f2ded8fff8..0000000000 --- a/client_api/diracclient/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -DiracClient | Rucio Documentation - - - - - - - - - -

    DiracClient

    add_files​

    -

    Bulk add files :

      -
    • Create the file and replica.
      • -
    • If doesn't exist create the dataset containing the file as well as a rule on the dataset on ANY sites.
      • -
    • Create all the ascendants of the dataset if they do not exist
      • -

    Arguments:

    lfns: List of lfn (dictionary {'lfn': <lfn>, 'rse': <rse>, 'bytes': <bytes>, 'adler32': <adler32>, 'guid': <guid>, 'pfn': <pfn>}

    ignore_availability: A boolean to ignore blocked sites.

    parents_metadata: Metadata for selected hierarchy DIDs. (dictionary {'lpn': {key : value}}). Default=None

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/downloadclient/index.html b/client_api/downloadclient/index.html deleted file mode 100644 index 4b07e3dfd0..0000000000 --- a/client_api/downloadclient/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - - -DownloadClient | Rucio Documentation - - - - - - - - - -

    DownloadClient

    __init__​

    -

    Initialises the basic settings for an DownloadClient object

    Arguments:

    client: Optional: rucio.client.client.Client object. If None, a new object will be created.

    external_traces: Optional: reference to a list where traces can be added

    logger: Optional: logging.Logger object. If None, default logger will be used.

     -

    download_pfns​

    -

    Download items with a given PFN. This function can only download files, no datasets.

    Arguments:

    items: List of dictionaries. Each dictionary describing a file to download. Keys: -pfn - PFN string of this file -did - DID string of this file (e.g. 'scope:file.name'). Wildcards are not allowed -rse - rse name (e.g. 'CERN-PROD_DATADISK'). RSE Expressions are not allowed -base_dir - Optional: Base directory where the downloaded files will be stored. (Default: '.') -no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) -adler32 - Optional: The adler32 checmsum to compare the downloaded files adler32 checksum with -md5 - Optional: The md5 checksum to compare the downloaded files md5 checksum with -transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) -check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum.

    num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high.

    trace_custom_fields: Custom key value pairs to send with the traces

    traces_copy_out: reference to an external list, where the traces should be uploaded

    deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised

    Raises:

    InputValidationError: if one of the input items is in the wrong format

    NoFilesDownloaded: if no files could be downloaded

    NotAllFilesDownloaded: if not all files could be downloaded

    RucioException: if something unexpected went wrong during the download

    Returns:

    a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState -clientState can be one of the following: ALREADY_DONE, DONE, FILE_NOT_FOUND, FAIL_VALIDATE, FAILED

     -

    download_dids​

    -

    Download items with given DIDs. This function can also download datasets and wildcarded DIDs.

    Arguments:

    items: List of dictionaries. Each dictionary describing an item to download. Keys: -did - DID string of this file (e.g. 'scope:file.name') -filters - Filter to select DIDs for download. Optional if DID is given -rse - Optional: rse name (e.g. 'CERN-PROD_DATADISK') or rse expression from where to download -impl - Optional: name of the protocol implementation to be used to download this item. -no_resolve_archives - Optional: bool indicating whether archives should not be considered for download (Default: False) -resolve_archives - Deprecated: Use no_resolve_archives instead -force_scheme - Optional: force a specific scheme to download this item. (Default: None) -base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') -no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) -nrandom - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset -ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) -transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) -transfer_speed_timeout - Optional: Minimum allowed transfer speed (in KBps). Ignored if transfer_timeout set. Otherwise, used to compute default timeout (Default: 500) -check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum.

    num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high.

    trace_custom_fields: Custom key value pairs to send with the traces.

    traces_copy_out: reference to an external list, where the traces should be uploaded

    deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised

    sort: Select best replica by replica sorting algorithm. Available algorithms: -geoip - based on src/dst IP topographical distance -closeness - based on src/dst closeness -dynamic - Rucio Dynamic Smart Sort (tm)

    Raises:

    InputValidationError: if one of the input items is in the wrong format

    NoFilesDownloaded: if no files could be downloaded

    NotAllFilesDownloaded: if not all files could be downloaded

    RucioException: if something unexpected went wrong during the download

    Returns:

    a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState

     - -

    Download items using a given metalink file.

    Arguments:

    item: dictionary describing an item to download. Keys: -base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') -no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) -ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) -transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) -check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum.

    num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high.

    trace_custom_fields: Custom key value pairs to send with the traces.

    traces_copy_out: reference to an external list, where the traces should be uploaded

    deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised

    Raises:

    InputValidationError: if one of the input items is in the wrong format

    NoFilesDownloaded: if no files could be downloaded

    NotAllFilesDownloaded: if not all files could be downloaded

    RucioException: if something unexpected went wrong during the download

    Returns:

    a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState

     -

    download_aria2c​

    -

    Uses aria2c to download the items with given DIDs. This function can also download datasets and wildcarded DIDs.

    It only can download files that are available via https/davs. -Aria2c needs to be installed and X509_USER_PROXY needs to be set!

    Arguments:

    items: List of dictionaries. Each dictionary describing an item to download. Keys: -did - DID string of this file (e.g. 'scope:file.name'). Wildcards are not allowed -rse - Optional: rse name (e.g. 'CERN-PROD_DATADISK') or rse expression from where to download -base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') -no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) -nrandom - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset -ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) -check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum.

    trace_custom_fields: Custom key value pairs to send with the traces

    filters: dictionary containing filter options

    deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised

    sort: Select best replica by replica sorting algorithm. Available algorithms: -geoip - based on src/dst IP topographical distance -closeness - based on src/dst closeness -dynamic - Rucio Dynamic Smart Sort (tm)

    Raises:

    InputValidationError: if one of the input items is in the wrong format

    NoFilesDownloaded: if no files could be downloaded

    NotAllFilesDownloaded: if not all files could be downloaded

    RucioException: if something went wrong during the download (e.g. aria2c could not be started)

    Returns:

    a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState

     -

    preferred_impl​

    -

    Finds the optimum protocol impl preferred by the client and

    supported by the remote RSE.

    Arguments:

    sources: List of sources for a given DID

    Raises:

    RucioException(msg): general exception with msg for more details.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/exportclient/index.html b/client_api/exportclient/index.html deleted file mode 100644 index a8da929686..0000000000 --- a/client_api/exportclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -ExportClient | Rucio Documentation - - - - - - - - - -

    ExportClient

    export_data​

    -

    Export RSE data (RSE, settings, attributes and distance).

    Arguments:

    distance: To include the distance.

    Returns:

    A dict containing data

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/fileclient/index.html b/client_api/fileclient/index.html deleted file mode 100644 index 996a9b9147..0000000000 --- a/client_api/fileclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -FileClient | Rucio Documentation - - - - - - - - - -

    FileClient

    list_file_replicas​

    -

    List file replicas.

    Arguments:

    scope: the scope.

    lfn: the lfn.

    Returns:

    List of replicas.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/importclient/index.html b/client_api/importclient/index.html deleted file mode 100644 index 787a2b8f3f..0000000000 --- a/client_api/importclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -ImportClient | Rucio Documentation - - - - - - - - - -

    ImportClient

    import_data​

    -

    Imports data into Rucio.

    Arguments:

    data: a dict containing data to be imported into Rucio.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/lifetimeclient/index.html b/client_api/lifetimeclient/index.html deleted file mode 100644 index 1af3e9ebd3..0000000000 --- a/client_api/lifetimeclient/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - -LifetimeClient | Rucio Documentation - - - - - - - - - -

    LifetimeClient

    list_exceptions​

    -

    List exceptions to Lifetime Model.

    Arguments:

    id: The id of the exception

    states: The states to filter

     -

    add_exception​

    -

    Add exceptions to Lifetime Model.

    Arguments:

    dids: The list of dids

    account: The account of the requester.

    pattern: The account.

    comments: The comments associated to the exception.

    expires_at: The expiration date of the exception. -returns: The id of the exception.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/lockclient/index.html b/client_api/lockclient/index.html deleted file mode 100644 index 7405830680..0000000000 --- a/client_api/lockclient/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - -LockClient | Rucio Documentation - - - - - - - - - -

    LockClient

    get_dataset_locks​

    -

    Get a dataset locks of the specified dataset.

    Arguments:

    scope: the scope of the did of the locks to list.

    name: the name of the did of the locks to list.

     -

    get_locks_for_dids​

    -

    Get list of locks for for all the files found, recursively, in the listed datasets or containers.

    Arguments:

    dids: list of dictionaries {"scope":..., "name":..., "type":...} -type can be either "dataset" or "container" -type is optional, but if specified, improves the query performance

    Returns:

    list of dictionaries with lock info

     -

    get_dataset_locks_by_rse​

    -

    Get all dataset locks of the specified rse.

    Arguments:

    rse: the rse of the locks to list.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/metaconventionsclient/index.html b/client_api/metaconventionsclient/index.html deleted file mode 100644 index 3a58260142..0000000000 --- a/client_api/metaconventionsclient/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -MetaConventionClient | Rucio Documentation - - - - - - - - - -

    MetaConventionClient

    add_key​

    -

    Sends the request to add an allowed key for DID metadata (update the DID Metadata Conventions table with a new key).

    Arguments:

    key: the name for the new key.

    key_type: the type of the key: all(container, dataset, file), collection(dataset or container), file, derived(compute from file for collection).

    value_type: the type of the value, if defined.

    value_regexp: the regular expression that values should match, if defined.

    Raises:

    Duplicate: if key already exists.

    Returns:

    True if key was created successfully.

     -

    list_keys​

    -

    Sends the request to list all keys for DID Metadata Conventions.

    Returns:

    a list containing the names of all keys.

     -

    list_values​

    -

    Sends the request to lists all allowed values for a DID key (all values for a key in DID Metadata Conventions).

    .

    :return: a list containing the names of all values for a key.

     -

    add_value​

    -

    Sends the request to add a value for a key in DID Metadata Convention.

    Arguments:

    key: the name for key.

    value: the value.

    Raises:

    Duplicate: if valid already exists.

    Returns:

    True if value was created successfully.

     -

    del_value​

    -

    Delete a key in the DID Metadata Conventions table.

    Arguments:

    key: the name for key.

    value: the value.

     -

    del_key​

    -

    Delete an allowed key.

    Arguments:

    key: the name for key.

     -

    update_key​

    -

    Update a key.

    Arguments:

    key: the name for key.

    type_: the type of the value, if defined.

    regexp: the regular expression that values should match, if defined.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/pingclient/index.html b/client_api/pingclient/index.html deleted file mode 100644 index 6f2fe99ba3..0000000000 --- a/client_api/pingclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -PingClient | Rucio Documentation - - - - - - - - - -

    PingClient

    ping​

    -

    Sends a ping request to the rucio server.

    Returns:

    Dictonnary with server information

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/replicaclient/index.html b/client_api/replicaclient/index.html deleted file mode 100644 index 019064a35a..0000000000 --- a/client_api/replicaclient/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - -ReplicaClient | Rucio Documentation - - - - - - - - - -

    ReplicaClient

    quarantine_replicas​

    -

    Add quaratined replicas for RSE.

    Arguments:

    replicas: List of replica infos: {'scope': <scope> (optional), 'name': <name> (optional), 'path':<path> (required)}.

    rse: RSE name.

    rse_id: RSE id. Either RSE name or RSE id must be specified, but not both

     -

    declare_bad_file_replicas​

    -

    Declare a list of bad replicas.

    Arguments:

    replicas: Either a list of PFNs (string) or a list of dicts {'scope': <scope>, 'name': <name>, 'rse_id': <rse_id> or 'rse': <rse_name>}

    reason: The reason of the loss.

    force: boolean, tell the serrver to ignore existing replica status in the bad_replicas table. Default: False

    Returns:

    Dictionary {"rse_name": ["did: error",...]} - list of strings for DIDs failed to declare, by RSE

     -

    declare_bad_did_replicas​

    -

    Declare a list of bad replicas.

    Arguments:

    rse: The RSE where the bad replicas reside

    dids: The DIDs of the bad replicas

    reason: The reason of the loss.

     -

    declare_suspicious_file_replicas​

    -

    Declare a list of bad replicas.

    Arguments:

    pfns: The list of PFNs.

    reason: The reason of the loss.

     -

    get_did_from_pfns​

    -

    Get the DIDs associated to a PFN on one given RSE

    Arguments:

    pfns: The list of PFNs.

    rse: The RSE name.

    Returns:

    A list of dictionaries {pfn: {'scope': scope, 'name': name}}

     -

    list_replicas​

    -

    List file replicas for a list of data identifiers (DIDs).

    Arguments:

    dids: The list of data identifiers (DIDs) like : -[{'scope': <scope1>, 'name': <name1>}, {'scope': <scope2>, 'name': <name2>}, ...]

    schemes: A list of schemes to filter the replicas. (e.g. file, http, ...)

    ignore_availability: Also include replicas from blocked RSEs into the list

    metalink: False (default) retrieves as JSON, -True retrieves as metalink4+xml.

    rse_expression: The RSE expression to restrict replicas on a set of RSEs.

    client_location: Client location dictionary for PFN modification {'ip', 'fqdn', 'site', 'latitude', 'longitude'}

    sort: Sort the replicas: geoip - based on src/dst IP topographical distance -closeness - based on src/dst closeness -dynamic - Rucio Dynamic Smart Sort (tm)

    domain: Define the domain. None is fallback to 'wan', otherwise 'wan, 'lan', or 'all'

    signature_lifetime: If supported, in seconds, restrict the lifetime of the signed PFN.

    nrandom: pick N random replicas. If the initial number of replicas is smaller than N, returns all replicas.

    resolve_archives: When set to True, find archives which contain the replicas.

    resolve_parents: When set to True, find all parent datasets which contain the replicas.

    updated_after: epoch timestamp or datetime object (UTC time), only return replicas updated after this time

    Returns:

    A list of dictionaries with replica information.

     -

    list_suspicious_replicas​

    -

    List file replicas tagged as suspicious.

    Arguments:

    rse_expression: The RSE expression to restrict replicas on a set of RSEs.

    younger_than: Datetime object to select the replicas which were declared since younger_than date. Default value = 10 days ago.

    nattempts: The minimum number of replica appearances in the bad_replica DB table from younger_than date. Default value = 0.

    state: State of the replica, either 'BAD' or 'SUSPICIOUS'. No value returns replicas with either state.

     -

    add_replica​

    -

    Add file replicas to a RSE.

    Arguments:

    rse: the RSE name.

    scope: The scope of the file.

    name: The name of the file.

    bytes_: The size in bytes.

    adler32: adler32 checksum.

    pfn: PFN of the file for non deterministic RSE.

    md5: md5 checksum.

    meta: Metadata attributes.

    Returns:

    True if files were created successfully.

     -

    add_replicas​

    -

    Bulk add file replicas to a RSE.

    Arguments:

    rse: the RSE name.

    files: The list of files. This is a list of DIDs like : -[{'scope': <scope1>, 'name': <name1>}, {'scope': <scope2>, 'name': <name2>}, ...]

    ignore_availability: Ignore the RSE blocklsit.

    Returns:

    True if files were created successfully.

     -

    delete_replicas​

    -

    Bulk delete file replicas from a RSE.

    Arguments:

    rse: the RSE name.

    files: The list of files. This is a list of DIDs like : -[{'scope': <scope1>, 'name': <name1>}, {'scope': <scope2>, 'name': <name2>}, ...]

    ignore_availability: Ignore the RSE blocklist.

    Returns:

    True if files have been deleted successfully.

     -

    update_replicas_states​

    -

    Bulk update the file replicas states from a RSE.

    Arguments:

    rse: the RSE name.

    files: The list of files. This is a list of DIDs like : -[{'scope': <scope1>, 'name': <name1>, 'state': <state1>}, {'scope': <scope2>, 'name': <name2>, 'state': <state2>}, ...], -where a state value can be either of: -'A' (AVAILABLE) -'U' (UNAVAILABLE) -'C' (COPYING) -'B' (BEING_DELETED) -'D' (BAD) -'T' (TEMPORARY_UNAVAILABLE)

    Returns:

    True if replica states have been updated successfully, otherwise an exception is raised.

     -

    list_dataset_replicas​

    -

    List dataset replicas for a did (scope:name).

    Arguments:

    scope: The scope of the dataset.

    name: The name of the dataset.

    deep: Lookup at the file level.

    Returns:

    A list of dict dataset replicas.

     -

    list_dataset_replicas_bulk​

    -

    List dataset replicas for a did (scope:name).

    Arguments:

    dids: The list of DIDs of the datasets.

    Returns:

    A list of dict dataset replicas.

     -

    list_dataset_replicas_vp​

    -

    List dataset replicas for a DID (scope:name) using the

    Virtual Placement service.

    NOTICE: This is an RnD function and might change or go away at any time.

    Arguments:

    scope: The scope of the dataset.

    name: The name of the dataset.

    deep: Lookup at the file level.

    Returns:

    If VP exists a list of dicts of sites

     -

    list_datasets_per_rse​

    -

    List datasets at a RSE.

    Arguments:

    rse: the rse name.

    filters: dictionary of attributes by which the results should be filtered.

    limit: limit number.

    Returns:

    A list of dict dataset replicas.

     -

    add_bad_pfns​

    -

    Declare a list of bad replicas.

    Arguments:

    pfns: The list of PFNs.

    reason: The reason of the loss.

    state: The state of the replica. Either BAD, SUSPICIOUS, TEMPORARY_UNAVAILABLE

    expires_at: Specify a timeout for the TEMPORARY_UNAVAILABLE replicas. None for BAD files.

    Returns:

    True if PFNs were created successfully.

     -

    set_tombstone​

    -

    Set a tombstone on a list of replicas.

    Arguments:

    replicas: list of replicas.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/requestclient/index.html b/client_api/requestclient/index.html deleted file mode 100644 index e5f0186f14..0000000000 --- a/client_api/requestclient/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - -RequestClient | Rucio Documentation - - - - - - - - - -

    RequestClient

    list_requests​

    -

    Return latest request details

    Returns:

    request information

     -

    list_requests_history​

    -

    Return historical request details

    Returns:

    request information

     -

    list_request_by_did​

    -

    Return latest request details for a DID

    Arguments:

    name: DID

    rse: Destination RSE name

    scope: rucio scope, defaults to None

    Raises:

    exc_cls: from BaseClient._get_exception

    Returns:

    request information

     -

    list_request_history_by_did​

    -

    Return latest request details for a DID

    Arguments:

    name: DID

    rse: Destination RSE name

    scope: rucio scope, defaults to None

    Raises:

    exc_cls: from BaseClient._get_exception

    Returns:

    request information

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/rseclient/index.html b/client_api/rseclient/index.html deleted file mode 100644 index ae3520aac1..0000000000 --- a/client_api/rseclient/index.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - - -RSEClient | Rucio Documentation - - - - - - - - - -

    RSEClient

    get_rse​

    -

    Returns details about the referred RSE.

    Arguments:

    rse: Name of the referred RSE

    Raises:

    RSENotFound: if the referred RSE was not found in the database

    Returns:

    A dict containing all attributes of the referred RSE

     -

    add_rse​

    -

    Sends the request to create a new RSE.

    Arguments:

    rse: the name of the rse.

    deterministic: Boolean to know if the pfn is generated deterministically.

    volatile: Boolean for RSE cache.

    city: City for the RSE.

    region_code: The region code for the RSE.

    country_name: The country.

    continent: The continent.

    time_zone: Timezone.

    staging_area: Staging area.

    ISP: Internet service provider.

    rse_type: RSE type.

    latitude: Latitude coordinate of RSE.

    longitude: Longitude coordinate of RSE.

    ASN: Access service network.

    availability: Availability.

    Raises:

    Duplicate: if rse already exists.

    Returns:

    True if location was created successfully else False.

     -

    update_rse​

    -

    Update RSE properties like availability or name.

    Arguments:

    rse: the name of the new rse.

    parameters: A dictionary with property (name, read, write, delete as keys).

     -

    delete_rse​

    -

    Sends the request to delete a rse.

    Arguments:

    rse: the name of the rse.

    Returns:

    True if location was created successfully else False.

     -

    list_rses​

    -

    Sends the request to list all rucio locations(RSEs).

    Returns:

    a list containing the names of all rucio locations.

     -

    add_rse_attribute​

    -

    Sends the request to add a RSE attribute.

    Arguments:

    rse: the name of the rse.

    key: the attribute key.

    value: the attribute value.

    Raises:

    Duplicate: if RSE attribute already exists.

    Returns:

    True if RSE attribute was created successfully else False.

     -

    delete_rse_attribute​

    -

    Sends the request to delete a RSE attribute.

    Arguments:

    rse: the RSE name.

    key: the attribute key.

    Returns:

    True if RSE attribute was deleted successfully else False.

     -

    list_rse_attributes​

    -

    Sends the request to get RSE attributes.

    Arguments:

    rse: The RSE name.

    Returns:

    A dict with the RSE attribute name/value pairs.

     -

    add_protocol​

    -

    Sends the request to create a new protocol for the given RSE.

    Arguments:

    rse: the name of the rse.

    scheme: identifier of this protocol

    params: Attributes of the protocol. Supported are: -hostname: hostname for this protocol (default = localhost) -port: port for this protocol (default = 0) -prefix: string used as a prfeix for this protocol when generating the PFN (default = None) -impl: qualified name of the implementation class for this protocol (mandatory) -read: integer representing the priority of this procotol for read operations (default = -1) -write: integer representing the priority of this procotol for write operations (default = -1) -delete: integer representing the priority of this procotol for delete operations (default = -1) -extended_attributes: miscellaneous protocol specific information e.g. spacetoken for SRM (default = None)

    Raises:

    Duplicate: if protocol with same hostname, port and protocol identifier -already exists for the given RSE.

    RSENotFound: if the RSE doesn't exist.

    KeyNotFound: if params is missing manadtory attributes to create the -protocol.

    AccessDenied: if not authorized.

    Returns:

    True if protocol was created successfully else False.

     -

    get_protocols​

    -

    Returns protocol information. Parameter combinations are:

    (operation OR default) XOR protocol.

    Arguments:

    rse: the RSE name.

    protocol_domain: The scope of the protocol. Supported are 'LAN', 'WAN', and 'ALL' (as default).

    operation: The name of the requested operation (read, write, or delete). -If None, all operations are queried.

    default: Indicates if only the default operations should be returned.

    scheme: The identifier of the requested protocol.

    Raises:

    RSENotFound: if the RSE doesn't exist.

    RSEProtocolNotSupported: if no matching protocol entry could be found.

    RSEOperationNotSupported: if no matching protocol entry for the requested -operation could be found.

    Returns:

    A dict with details about each matching protocol.

     -

    lfns2pfns​

    -

    Returns PFNs that should be used at a RSE, corresponding to requested LFNs.

    The PFNs are generated for the RSE regardless of whether a replica exists for the LFN.

    Arguments:

    rse: the RSE name

    lfns: A list of LFN strings to translate to PFNs.

    protocol_domain: The scope of the protocol. Supported are 'LAN', 'WAN', and 'ALL' (as default).

    operation: The name of the requested operation (read, write, or delete). -If None, all operations are queried.

    scheme: The identifier of the requested protocol (gsiftp, https, davs, etc).

    Raises:

    RSENotFound: if the RSE doesn't exist.

    RSEProtocolNotSupported: if no matching protocol entry could be found.

    RSEOperationNotSupported: if no matching protocol entry for the requested -operation could be found.

    Returns:

    A dictionary of LFN / PFN pairs.

     -

    delete_protocols​

    -

    Deletes matching protocols from RSE. Protocols using the same identifier can be

    distinguished by hostname and port.

    Arguments:

    rse: the RSE name.

    scheme: identifier of the protocol.

    hostname: hostname of the protocol.

    port: port of the protocol.

    Raises:

    RSEProtocolNotSupported: if no matching protocol entry could be found.

    RSENotFound: if the RSE doesn't exist.

    AccessDenied: if not authorized.

    Returns:

    True if success.

     -

    update_protocols​

    -

    Updates matching protocols from RSE. Protocol using the same identifier can be

    distinguished by hostname and port.

    Arguments:

    rse: the RSE name.

    scheme: identifier of the protocol.

    data: A dict providing the new values of the protocol attributes. -Keys must match column names in database.

    hostname: hostname of the protocol.

    port: port of the protocol.

    Raises:

    RSEProtocolNotSupported: if no matching protocol entry could be found.

    RSENotFound: if the RSE doesn't exist.

    KeyNotFound: if invalid data was provided for update.

    AccessDenied: if not authorized.

    Returns:

    True if success.

     -

    swap_protocols​

    -

    Swaps the priorities of the provided operation.

    Arguments:

    rse: the RSE name.

    domain: the domain in which priorities should be swapped i.e. wan or lan.

    operation: the operation that should be swapped i.e. read, write, or delete.

    scheme_a: the scheme of one of the two protocols to be swapped, e.g. srm.

    scheme_b: the scheme of the other of the two protocols to be swapped, e.g. http.

    Raises:

    RSEProtocolNotSupported: if no matching protocol entry could be found.

    RSENotFound: if the RSE doesn't exist.

    KeyNotFound: if invalid data was provided for update.

    AccessDenied: if not authorized.

    Returns:

    True if success.

     -

    add_qos_policy​

    -

    Add a QoS policy from an RSE.

    Arguments:

    rse_id: The id of the RSE.

    qos_policy: The QoS policy to add.

    session: The database session in use.

    Raises:

    Duplicate: If the QoS policy already exists.

    Returns:

    True if successful, except otherwise.

     -

    delete_qos_policy​

    -

    Delete a QoS policy from an RSE.

    Arguments:

    rse_id: The id of the RSE.

    qos_policy: The QoS policy to delete.

    session: The database session in use.

    Returns:

    True if successful, silent failure if QoS policy does not exist.

     -

    list_qos_policies​

    -

    List all QoS policies of an RSE.

    Arguments:

    rse_id: The id of the RSE.

    session: The database session in use.

    Returns:

    List containing all QoS policies.

     -

    set_rse_usage​

    -

    Set RSE usage information.

    Arguments:

    rse: the RSE name.

    source: the information source, e.g. srm.

    used: the used space in bytes.

    free: the free in bytes.

    files: the number of files

    Returns:

    True if successful

     -

    get_rse_usage​

    -

    Get RSE usage information.

    Arguments:

    rse: the RSE name.

    filters: dictionary of attributes by which the results should be filtered

    Returns:

    True if successful, otherwise false.

     -

    list_rse_usage_history​

    -

    List RSE usage history information.

    Arguments:

    rse: The RSE name.

    filters: dictionary of attributes by which the results should be filtered.

    Returns:

    list of dictionaries.

     -

    set_rse_limits​

    -

    Set RSE limit information.

    Arguments:

    rse: The RSE name.

    name: The name of the limit.

    value: The feature value.

    Returns:

    True if successful

     -

    get_rse_limits​

    -

    Get RSE limits.

    Arguments:

    rse: The RSE name.

    Returns:

    An iterator of RSE limits as dicts with 'name' and 'value' as keys.

     -

    delete_rse_limits​

    -

    Delete RSE limit information.

    Arguments:

    rse: The RSE name.

    name: The name of the limit.

    Returns:

    True if successful

     -

    add_distance​

    -

    Add a src-dest distance.

    Arguments:

    source: The source.

    destination: The destination.

    parameters: A dictionary with property.

     -

    update_distance​

    -

    Update distances with the given RSE ids.

    Arguments:

    source: The source.

    destination: The destination.

    parameters: A dictionary with property.

     -

    get_distance​

    -

    Get distances between rses.

    Arguments:

    source: The source RSE.

    destination: The destination RSE.

    Returns:

    distance: List of dictionaries.

     -

    delete_distance​

    -

    Delete distances with the given RSE ids.

    Arguments:

    source: The source.

    destination: The destination.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/ruleclient/index.html b/client_api/ruleclient/index.html deleted file mode 100644 index 7d59f9e31d..0000000000 --- a/client_api/ruleclient/index.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - - -RuleClient | Rucio Documentation - - - - - - - - - -

    RuleClient

    add_replication_rule​

    -

    Arguments:

    dids: The data identifier set.

    copies: The number of replicas.

    rse_expression: Boolean string expression to give the list of RSEs.

    priority: Priority of the transfers.

    lifetime: The lifetime of the replication rules (in seconds).

    grouping: ALL - All files will be replicated to the same RSE. -DATASET - All files in the same dataset will be replicated to the same RSE. -NONE - Files will be completely spread over all allowed RSEs without any grouping considerations at all.

    notify: Notification setting for the rule (Y, N, C).

    source_replica_expression: RSE Expression for RSEs to be considered for source replicas.

    activity: Transfer Activity to be passed to FTS.

    account: The account owning the rule.

    meta: Metadata, as dictionary.

    ignore_availability: Option to ignore the availability of RSEs.

    purge_replicas: When the rule gets deleted purge the associated replicas immediately.

    ask_approval: Ask for approval of this replication rule.

    asynchronous: Create rule asynchronously by judge-injector.

    locked: If the rule is locked, it cannot be deleted.

    delay_injection:

    comment: Comment about the rule.

    weight: If the weighting option of the replication rule is used, the choice of RSEs takes their weight into account.

     -

    delete_replication_rule​

    -

    Deletes a replication rule and all associated locks.

    Arguments:

    rule_id: The id of the rule to be deleted

    purge_replicas: Immediately delete the replicas.

    Raises:

    ``: RuleNotFound, AccessDenied

     -

    get_replication_rule​

    -

    Get a replication rule.

    Arguments:

    rule_id: The id of the rule to be retrieved.

    Raises:

    ``: RuleNotFound

     -

    update_replication_rule​

    -

    Arguments:

    rule_id: The id of the rule to be retrieved.

    options: Options dictionary.

    Raises:

    ``: RuleNotFound

     -

    reduce_replication_rule​

    -

    Arguments:

    rule_id: Rule to be reduced.

    copies: Number of copies of the new rule.

    exclude_expression: RSE Expression of RSEs to exclude.

    Raises:

    ``: RuleReplaceFailed, RuleNotFound

     -

    move_replication_rule​

    -

    Move a replication rule to another RSE and, once done, delete the original one.

    Arguments:

    rule_id: Rule to be moved.

    rse_expression: RSE expression of the new rule.

    override: Configurations to update for the new rule.

    Raises:

    ``: RuleNotFound, RuleReplaceFailed

     -

    approve_replication_rule​

    -

    Arguments:

    rule_id: Rule to be approved.

    Raises:

    ``: RuleNotFound

     -

    deny_replication_rule​

    -

    Arguments:

    rule_id: Rule to be denied.

    reason: Reason for denying the rule.

    Raises:

    ``: RuleNotFound

     -

    list_replication_rule_full_history​

    -

    List the rule history of a DID.

    Arguments:

    scope: The scope of the DID.

    name: The name of the DID.

     -

    examine_replication_rule​

    -

    Examine a replication rule for errors during transfer.

    Arguments:

    rule_id: Rule to be denied.

    Raises:

    ``: RuleNotFound

     -

    list_replica_locks​

    -

    List details of all replica locks for a rule.

    Arguments:

    rule_id: Rule to be denied.

    Raises:

    ``: RuleNotFound

     -

    list_replication_rules​

    -

    List all replication rules which match a filter

    Arguments:

    filters: dictionary of attributes by which the rules should be filtered

    Returns:

    True if successful, otherwise false.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/scopeclient/index.html b/client_api/scopeclient/index.html deleted file mode 100644 index 2fb38f1e3e..0000000000 --- a/client_api/scopeclient/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -ScopeClient | Rucio Documentation - - - - - - - - - -

    ScopeClient

    add_scope​

    -

    Sends the request to add a new scope.

    Arguments:

    account: the name of the account to add the scope to.

    scope: the name of the new scope.

    Raises:

    Duplicate: if scope already exists.

    AccountNotFound: if account doesn't exist.

    Returns:

    True if scope was created successfully.

     -

    list_scopes​

    -

    Sends the request to list all scopes.

    Returns:

    a list containing the names of all scopes.

     -

    list_scopes_for_account​

    -

    Sends the request to list all scopes for a rucio account.

    Arguments:

    account: the rucio account to list scopes for.

    Raises:

    AccountNotFound: if account doesn't exist.

    ScopeNotFound: if no scopes exist for account.

    Returns:

    a list containing the names of all scopes for a rucio account.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/subscriptionclient/index.html b/client_api/subscriptionclient/index.html deleted file mode 100644 index 0e2853b913..0000000000 --- a/client_api/subscriptionclient/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - -SubscriptionClient | Rucio Documentation - - - - - - - - - -

    SubscriptionClient

    add_subscription​

    -

    Adds a new subscription which will be verified against every new added file and dataset

    Arguments:

    name: Name of the subscription

    account: Account identifier

    filter_: Dictionary of attributes by which the input data should be filtered -Example: \{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'\}

    replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression

    comments: Comments for the subscription

    lifetime: Subscription's lifetime (days); False if subscription has no lifetime

    retroactive: Flag to know if the subscription should be applied on previous data

    dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)

    priority: The priority of the subscription (3 by default)

     -

    list_subscriptions​

    -

    Returns a dictionary with the subscription information :

    Examples: \{'status': 'INACTIVE/ACTIVE/BROKEN', 'last_modified_date': ...\}

    Arguments:

    name: Name of the subscription

    account: Account identifier

    Raises:

    ``: exception.NotFound if subscription is not found

    Returns:

    Dictionary containing subscription parameter

     -

    update_subscription​

    -

    Updates a subscription

    Arguments:

    name: Name of the subscription

    account: Account identifier

    filter_: Dictionary of attributes by which the input data should be filtered -Example: \{'dsn': 'data11_hi*.express_express.*,data11_hi*physics_MinBiasOverlay*', 'account': 'tzero'\}

    replication_rules: Replication rules to be set : Dictionary with keys copies, rse_expression, weight, rse_expression

    comments: Comments for the subscription

    lifetime: Subscription's lifetime (days); False if subscription has no lifetime

    retroactive: Flag to know if the subscription should be applied on previous data

    dry_run: Just print the subscriptions actions without actually executing them (Useful if retroactive flag is set)

    priority: The priority of the subscription

    Raises:

    ``: exception.NotFound if subscription is not found

     -

    list_subscription_rules​

    -

    List the associated rules of a subscription.

    Arguments:

    account: Account of the subscription.

    name: Name of the subscription.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/touchclient/index.html b/client_api/touchclient/index.html deleted file mode 100644 index 97359c6c47..0000000000 --- a/client_api/touchclient/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -TouchClient | Rucio Documentation - - - - - - - - - -

    TouchClient

    touch​

    -

    Sends a touch trace for a given file or dataset.

    Arguments:

    scope: the scope of the file/dataset to update.

    name: the name of file/dataset to update.

    rse: optional parameter if a specific replica should be touched.

    Raises:

    DataIdentifierNotFound: if given dids does not exist.

    RSENotFound: if rse is not None and given rse does not exist.

    UnsupportedDIDType: if type of the given DID is not FILE or DATASET.

    RucioException: if trace could not be sent successfully.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/client_api/uploadclient/index.html b/client_api/uploadclient/index.html deleted file mode 100644 index b234356a30..0000000000 --- a/client_api/uploadclient/index.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - -UploadClient | Rucio Documentation - - - - - - - - - -

    UploadClient

    __init__​

    -

    Initialises the basic settings for an UploadClient object

    Arguments:

    _client: - Optional: rucio.client.client.Client object. If None, a new object will be created.

    logger: - Optional: logging.Logger object. If None, default logger will be used.

     -

    upload​

    -

    Arguments:

    items: List of dictionaries. Each dictionary describing a file to upload. Keys: -path - path of the file that will be uploaded -rse - rse expression/name (e.g. 'CERN-PROD_DATADISK') where to upload the file -did_scope - Optional: custom did scope (Default: user.<account>) -did_name - Optional: custom did name (Default: name of the file) -dataset_scope - Optional: custom dataset scope -dataset_name - Optional: custom dataset name -dataset_meta - Optional: custom metadata for dataset -impl - Optional: name of the protocol implementation to be used to upload this item. -force_scheme - Optional: force a specific scheme (if PFN upload this will be overwritten) (Default: None) -pfn - Optional: use a given PFN (this sets no_register to True, and no_register becomes mandatory) -no_register - Optional: if True, the file will not be registered in the rucio catalogue -register_after_upload - Optional: if True, the file will be registered after successful upload -lifetime - Optional: the lifetime of the file after it was uploaded -transfer_timeout - Optional: time after the upload will be aborted -guid - Optional: guid of the file -recursive - Optional: if set, parses the folder structure recursively into collections

    summary_file_path: Optional: a path where a summary in form of a json file will be stored

    traces_copy_out: reference to an external list, where the traces should be uploaded

    ignore_availability: ignore the availability of a RSE

    activity: the activity set to the rule if no dataset is specified

    Raises:

    InputValidationError: if any input arguments are in a wrong format

    RSEWriteBlocked: if a given RSE is not available for writing

    NoFilesUploaded: if no files were successfully uploaded

    NotAllFilesUploaded: if not all files were successfully uploaded

    Returns:

    0 on success

     -

    preferred_impl​

    -

    Finds the optimum protocol impl preferred by the client and

    supported by the remote RSE.

    Arguments:

    rse_settings: dictionary containing the RSE settings

    domain: The network domain, either 'wan' (default) or 'lan'

    Raises:

    RucioException(msg): general exception with msg for more details.

    Copyright © 2023 CERN
    - - \ No newline at end of file diff --git a/component_leads/index.html b/component_leads/index.html index f4126a17a9..c176363a62 100644 --- a/component_leads/index.html +++ b/component_leads/index.html @@ -9,15 +9,15 @@ - - + + -

    Component development leads

    The component lead is responsible for the planning and development of patches +

    Component development leads

    The component lead is responsible for the planning and development of patches and features for the respective component. This does not mean that the component lead is the only person developing the component, but he/she should direct the efforts and be the point of contact in case of problems.

    Rucio Project Leader: Martin Barisits

    -
    ComponentLead (+Deputies)Description
    Authentication & AuthorisationDimitrios Christidis, Mario LassnigClient-server authentication, Rucio tokens, auth methods (kerberos, ssh, userpass, OIDC, ...)
    ClientsMaggie Voetberg, Mario LassnigGeneral Python Clients and Command Line interface related development, rucio download, rucio upload; Specific component related client functionality is part of the other components
    Consistency checksFabio Luchetti, Guilherme LimaDark data detection daemon: Auditor
    Core & InternalsMartin Barisits, Mario LassnigCore functionality not specifically part of other components
    DatabaseDimitrios Xenakis, Mario Lassnig, Martin BarisitsDatabase (Compatibility and optimisation) and SQLAlchemy framework specific issues
    Dataset deletionAlexander Richards, Martin BarisitsDataset deletion daemon: Undertaker
    DeletionHugo Gonzalez Labrador, Cedric SerfonFile deletion daemon: Reaper
    DIRACCedric SerfonRucio integration with Dirac
    Docker & KubernetesRiccardo Di Maio, Mario Lassnig, Eric Vaandering, Hugo Gonzalez LabradorDocker & Kubernetes deployment
    DocumentationMartin Barisits, Maggie VoetbergGeneral documentation
    Jupyterlab extensionFrancesc Torradeflot, Enrique Garcia GarciaRucio Jupyterlab extension
    Life time modelDimitrios ChristidisLife time model processing and exceptions
    MessagingAlexander Richards, Mario LassnigMessaging daemon: Hermes, Creation of eMails and ActiveMQ messages
    MetadataRob Barnsley, Dimitrios XenakisMetadata workflows
    Monitoring & TracesMayank Sharma, Mario LassnigAll things internal monitoring and traces
    Multi VOTim NobleIssues and developments related to Rucio Multi VO mode
    PoliciesJames PerryAll things related to separate settings/config/policies into community specific things
    Probes & AlarmsDimitrios Christidis, Eric VaanderingProbes and alarms for Nagios
    ProtocolsMaggie Voetberg, Mario LassnigProtocols (Upload, Download, Deletion)
    RebalancingCedric SerfonData rebalancing daemon: BB8
    RecoveryCedric SerfonData recovery daemon: Necromancer and suspicious replica recovery
    Release managementMartin Barisits, Dimitrios ChristidisPackaging of new versions, package configuration
    ReplicasRiccardo Di Maio, Alexander RichardsReplicas related workflows (list_replicas, add_replica, ...)
    REST & APIMaggie Voetberg, Martin BarisitsWeb-Framework (Web.py & Flask)
    RulesRiccardo Di Maio, Martin BarisitsReplication rules and rule daemons: Judge
    SubscriptionsCedric SerfonSubscription daemon: Transmogrifier
    TestingMayank Sharma, Riccardo Di MaioRegression and Unit tests, automatic tests of submissions
    TransfersRiccardo Di Maio, Hugo Gonzalez LabradorTransfer daemons: conveyor and functional transfer tests
    WebUIMayank Sharma, Eraldo Silva JuniorWeb user interface: Rucio Web UI
    Copyright © 2023 CERN
    +
    ComponentLead (+Deputies)Description
    Authentication & AuthorisationDimitrios Christidis, Mario LassnigClient-server authentication, Rucio tokens, auth methods (kerberos, ssh, userpass, OIDC, ...)
    ClientsMaggie Voetberg, Mario LassnigGeneral Python Clients and Command Line interface related development, rucio download, rucio upload; Specific component related client functionality is part of the other components
    Consistency checksFabio Luchetti, Guilherme LimaDark data detection daemon: Auditor
    Core & InternalsMartin Barisits, Mario LassnigCore functionality not specifically part of other components
    DatabaseDimitrios Xenakis, Mario Lassnig, Martin BarisitsDatabase (Compatibility and optimisation) and SQLAlchemy framework specific issues
    Dataset deletionAlexander Richards, Martin BarisitsDataset deletion daemon: Undertaker
    DeletionHugo Gonzalez Labrador, Cedric SerfonFile deletion daemon: Reaper
    DIRACCedric SerfonRucio integration with Dirac
    Docker & KubernetesRiccardo Di Maio, Mario Lassnig, Eric Vaandering, Hugo Gonzalez LabradorDocker & Kubernetes deployment
    DocumentationMartin Barisits, Maggie VoetbergGeneral documentation
    Jupyterlab extensionFrancesc Torradeflot, Enrique Garcia GarciaRucio Jupyterlab extension
    Life time modelDimitrios ChristidisLife time model processing and exceptions
    MessagingAlexander Richards, Mario LassnigMessaging daemon: Hermes, Creation of eMails and ActiveMQ messages
    MetadataRob Barnsley, Dimitrios XenakisMetadata workflows
    Monitoring & TracesMayank Sharma, Mario LassnigAll things internal monitoring and traces
    Multi VOTim NobleIssues and developments related to Rucio Multi VO mode
    PoliciesJames PerryAll things related to separate settings/config/policies into community specific things
    Probes & AlarmsDimitrios Christidis, Eric VaanderingProbes and alarms for Nagios
    ProtocolsMaggie Voetberg, Mario LassnigProtocols (Upload, Download, Deletion)
    RebalancingCedric SerfonData rebalancing daemon: BB8
    RecoveryCedric SerfonData recovery daemon: Necromancer and suspicious replica recovery
    Release managementMartin Barisits, Dimitrios ChristidisPackaging of new versions, package configuration
    ReplicasRiccardo Di Maio, Alexander RichardsReplicas related workflows (list_replicas, add_replica, ...)
    REST & APIMaggie Voetberg, Martin BarisitsWeb-Framework (Web.py & Flask)
    RulesRiccardo Di Maio, Martin BarisitsReplication rules and rule daemons: Judge
    SubscriptionsCedric SerfonSubscription daemon: Transmogrifier
    TestingMayank Sharma, Riccardo Di MaioRegression and Unit tests, automatic tests of submissions
    TransfersRiccardo Di Maio, Hugo Gonzalez LabradorTransfer daemons: conveyor and functional transfer tests
    WebUIMayank Sharma, Eraldo Silva JuniorWeb user interface: Rucio Web UI
    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/contact_us/index.html b/contact_us/index.html index a5e93373b1..27f11e01b2 100644 --- a/contact_us/index.html +++ b/contact_us/index.html @@ -9,11 +9,11 @@ - - + + -

    Contact us

    We know getting started can be difficult, which is why +

    Contact us

    We know getting started can be difficult, which is why our developers are always happy to help out! Reach out to us on any of the below channels for any assistance with Rucio.

    @@ -36,6 +36,6 @@

    Email usemail

    Social Media​

    Follow us on Mastodon to stay updated -with the latest on Rucio!

    Copyright © 2023 CERN
    +with the latest on Rucio!

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/contributing/index.html b/contributing/index.html index d89182dd9c..39f2013563 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -9,11 +9,11 @@ - - + + -

    Contributing Guide

    Thank you for participating​

    +

    Contributing Guide

    Thank you for participating​

    The following is a set of rules for contributing to Rucio and its packages. Use your best judgment, and feel free to propose changes to this document.

    @@ -203,6 +203,6 @@

    Human ReviewCoding Style​

    We use flake8 and pylint to sanitize our code. Please do the same before submitting a pull request.

    -

    A more indepth set of coding style guidelines can be found here.

    Copyright © 2023 CERN
    +

    A more indepth set of coding style guidelines can be found here.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/dependency_management/index.html b/developer/dependency_management/index.html index cee170680b..8ef1e0a2a6 100644 --- a/developer/dependency_management/index.html +++ b/developer/dependency_management/index.html @@ -9,11 +9,11 @@ - - + + -

    Dependency management

    Requirements file structure​

    +

    Dependency management

    Requirements file structure​

    The dependencies needed by Rucio are described in the rucio/requirements/ directory.

    The requirements in this directory are divided based on the application:

      @@ -92,6 +92,6 @@

      FAQ

      Why are client dependencies not pinned?​

      In certain use cases, the Rucio client is used as a library in other applications (See this issue for an example). -Because of this, client dependencies are left unpinned unless necessary.

    Copyright © 2023 CERN
    +Because of this, client dependencies are left unpinned unless necessary.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/dev_style_guide/index.html b/developer/dev_style_guide/index.html index a2902f38a8..7d29cd6061 100644 --- a/developer/dev_style_guide/index.html +++ b/developer/dev_style_guide/index.html @@ -9,11 +9,11 @@ - - + + -

    TL;DR - Install the provided pre-commits, follow their recommendations

    +

    TL;DR - Install the provided pre-commits, follow their recommendations

    General Style

    Rucio follows flake8 style, (with exclusions listed here). To use them to lint your code, run:

    @@ -88,6 +88,6 @@

    GitHub Actions

    These checks can also be run locally using

    tools/count_missing_type_annotations_utils.sh
    tools/run_pyright.sh generate {report_output_path.json}

    The first action will raise an error if your commits introduce more un-annotated types than it solves, -and the second ensures the added types are consistent with the rest of the codebase.

    Copyright © 2023 CERN
    +and the second ensures the added types are consistent with the rest of the codebase.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/project_structure/index.html b/developer/project_structure/index.html index bd45315519..5e882cebb1 100644 --- a/developer/project_structure/index.html +++ b/developer/project_structure/index.html @@ -9,11 +9,11 @@ - - + + -

    Project Structure

    The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication. +

    Project Structure

    The Rucio code structure is broken into multiple modules, to allow it to be grouped into packages without requiring code duplication. Before making a change, it is important to consider how your change will be used across different releases. This will greatly impact the structure of your change.

    A simplified diagram of Rucio&#39;s code structure. It is broken into 3 boxes labeled &quot;Rucio&quot;, &quot;Rucio Web&quot; and &quot;Rucio Client&quot;. The &quot;Rucio&quot; box contains the web and client boxes.

    @@ -58,6 +58,6 @@

    TestsTests contains utilities for testing.

    Transfertool​

    Similar to RSE, transfertool contains protocols for executing file transfers. -It can include calls to core, as transfer protocols sit server side.

    Copyright © 2023 CERN
    +It can include calls to core, as transfer protocols sit server side.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/rest_api_doc/index.html b/developer/rest_api_doc/index.html index a61fd2cd7d..1dec5bc1db 100644 --- a/developer/rest_api_doc/index.html +++ b/developer/rest_api_doc/index.html @@ -9,11 +9,11 @@ - - + + -

    REST API Documentation

    Rucio provides a Rest API interface for client-server communication. The code +

    REST API Documentation

    Rucio provides a Rest API interface for client-server communication. The code for the server is located in the Rucio project under lib/rucio/rest/flask/v1.

    The Rest API Documentation provides a sufficient documentation of all endpoints and should be descriptive enough so that it is not required to look at the code @@ -73,6 +73,6 @@

    Edit this page
    Last updated on by Martin Barisits

    Copyright © 2023 CERN
    +input validation.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/setting_up_intellij_dev_env/index.html b/developer/setting_up_intellij_dev_env/index.html index fc765ba1ab..85ab56304e 100644 --- a/developer/setting_up_intellij_dev_env/index.html +++ b/developer/setting_up_intellij_dev_env/index.html @@ -9,11 +9,11 @@ - - + + -

    Setting up a Rucio Developer environment using IntelliJ Ultimate

    This tutorial works on Linux, but it was confirmed, in the past, to not +

    Setting up a Rucio Developer environment using IntelliJ Ultimate

    This tutorial works on Linux, but it was confirmed, in the past, to not work on Windows. Windows support could have improved in later IntelliJ versions. If you manage to make it work, please tell us and update the documentation.

    @@ -90,6 +90,6 @@

    Debuggi
  • Use specified interpreter: select the rucio docker-compose remote interpreter.
    • -

    This will allow to debug the code on server side.

    Copyright © 2023 CERN
    +

    This will allow to debug the code on server side.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/setting_up_mac_apple_silicon/index.html b/developer/setting_up_mac_apple_silicon/index.html index 5ab7bc40d7..ea9edf725d 100644 --- a/developer/setting_up_mac_apple_silicon/index.html +++ b/developer/setting_up_mac_apple_silicon/index.html @@ -9,11 +9,11 @@ - - + + -

    Setting up a Rucio Developer environment on Mac with Apple Silicon

    Setting up a Rucio Developer environment on Mac with Apple Silicon​

    +

    Setting up a Rucio Developer environment on Mac with Apple Silicon

    Setting up a Rucio Developer environment on Mac with Apple Silicon​

    Currently Rucio packages and containers are only available for the x86_64 architecture.

    A Mac equipped with Apple Silicon can execute code compiled for the x86_64 instruction set via a translation mechanism known as Rosetta 2.

      @@ -29,6 +29,6 @@

      Docker en

      Set Docker default platform to linux/amd64:

          export DOCKER_DEFAULT_PLATFORM=linux/amd64

      Or run it as part of the command a single time:

      -
          DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f <docker-compose-file.yml>

    Copyright © 2023 CERN
    +
        DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f <docker-compose-file.yml>
    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/setting_up_vscode_dev_env/index.html b/developer/setting_up_vscode_dev_env/index.html index 139b9d9734..b95850dce1 100644 --- a/developer/setting_up_vscode_dev_env/index.html +++ b/developer/setting_up_vscode_dev_env/index.html @@ -9,11 +9,11 @@ - - + + -

    Setting up a Rucio Developer environment using Visual Studio Code

    Local Setup vs Remote Setup​

    +

    Setting up a Rucio Developer environment using Visual Studio Code

    Local Setup vs Remote Setup​

    It is possible to run the containers for rucio development locally or on a remote VM.

    For local development machines with limited resources (<16 GB RAM, < 4 Cores), it is recommended to run the containers on a remote VM. This will allow you to use your local machine for other tasks while the containers are running on the remote VM.

    Local development has been tested only on Linux hosts. @@ -286,6 +286,6 @@

    Debugg
    • detach the debugger from the debug process
    • run the cleanup task to remove all processes inside the container that were used for debugging.
      • -

    Copyright © 2023 CERN
    +
    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/type_annotation_guide/index.html b/developer/type_annotation_guide/index.html index cf9272aff6..66ef83134f 100644 --- a/developer/type_annotation_guide/index.html +++ b/developer/type_annotation_guide/index.html @@ -9,11 +9,11 @@ - - + + -

    Type Annotation Guide

    The purpose of this document is to collaboratively create the developer +

    Type Annotation Guide

    The purpose of this document is to collaboratively create the developer guidelines for static type checking of rucio's codebase.

    TL;DR New code has to be type annotated, old code should be migrated. Look into Best Practices for specific instructions on how to use @@ -264,6 +264,6 @@

    Best Practice

    Common Types​

    To ensure a consistent use of type annotations in Rucio, here is a list of common variables with their corresponding type:

    -
    Code sectionVariableTypeDescription
    *sessionsqlalchemy.orm.session.SessionThe sqlalchemy session.
    DIDscopestrThe scope of a DID.
    DIDnamestrThe name of a DID.
    DIDaccountstrThe account name.
    DIDdid_typestrThe DID type.
    Copyright © 2023 CERN
    +
    Code sectionVariableTypeDescription
    *sessionsqlalchemy.orm.session.SessionThe sqlalchemy session.
    DIDscopestrThe scope of a DID.
    DIDnamestrThe name of a DID.
    DIDaccountstrThe account name.
    DIDdid_typestrThe DID type.
    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/webui/streamedtables/index.html b/developer/webui/streamedtables/index.html index 226b703720..8f09928f71 100644 --- a/developer/webui/streamedtables/index.html +++ b/developer/webui/streamedtables/index.html @@ -9,11 +9,11 @@ - - + + -

    Using the WebUI StreamedTable Component

    Data presentation in the WebUI​

    +

    Using the WebUI StreamedTable Component

    Data presentation in the WebUI​

    An issue we encountered in the process of developing the WebUI which is particularly relevant in the context of writing a Rucio frontend is streaming. The "old" web frontend (which we want to replace) had the issue that it would @@ -250,6 +250,6 @@

    RouteListSubscription route, would be:

    -
    'use client';
    import { ListSubscription as ListSubscriptionStory } from "@/component-library/Pages/Subscriptions/ListSubscription";
    import { useEffect } from "react";
    import useComDOM from "@/lib/infrastructure/hooks/useComDOM";
    import { SubscriptionRuleStatesViewModel } from "@/lib/infrastructure/data/view-model/subscriptions";

    export default function ListSubscription({ params }: { params: { account: string }}) {
        // initialise ComDOM
        const ComDOM = useComDOM<SubscriptionRuleStatesViewModel>(
            "subscription-rule-states-query",
            [],
            false,
            Infinity,
            50,
            true
        )
        // auto-start query, GET data from /api/list-subscription, use param account
        useEffect(() => {
            const runQuery = async () => {
                await ComDOM.start({
                    url: new URL("http://localhost:3000/api/list-subscription"),
                    method: "GET",
                    headers: new Headers({
                        'Content-Type': 'application/json'
                    } as HeadersInit),
                    params: {
                        "account": params.account,
                    }
                })
            }
            runQuery()
        }, [])
        // * return a react component
        // * in this case the StreamedTable is wrapped by a Storybook Page
        // * we pass the ComDOM to this page so that it may be passed further down
        // to the StreamedTable
        return (
            <div>
                <ListSubscriptionStory
                    accountname={params.account}
                    comdom={ComDOM}
                />
            </div>
        )
    }

    Copyright © 2023 CERN
    +
    'use client';
    import { ListSubscription as ListSubscriptionStory } from "@/component-library/Pages/Subscriptions/ListSubscription";
    import { useEffect } from "react";
    import useComDOM from "@/lib/infrastructure/hooks/useComDOM";
    import { SubscriptionRuleStatesViewModel } from "@/lib/infrastructure/data/view-model/subscriptions";

    export default function ListSubscription({ params }: { params: { account: string }}) {
        // initialise ComDOM
        const ComDOM = useComDOM<SubscriptionRuleStatesViewModel>(
            "subscription-rule-states-query",
            [],
            false,
            Infinity,
            50,
            true
        )
        // auto-start query, GET data from /api/list-subscription, use param account
        useEffect(() => {
            const runQuery = async () => {
                await ComDOM.start({
                    url: new URL("http://localhost:3000/api/list-subscription"),
                    method: "GET",
                    headers: new Headers({
                        'Content-Type': 'application/json'
                    } as HeadersInit),
                    params: {
                        "account": params.account,
                    }
                })
            }
            runQuery()
        }, [])
        // * return a react component
        // * in this case the StreamedTable is wrapped by a Storybook Page
        // * we pass the ComDOM to this page so that it may be passed further down
        // to the StreamedTable
        return (
            <div>
                <ListSubscriptionStory
                    accountname={params.account}
                    comdom={ComDOM}
                />
            </div>
        )
    }
    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/webui/webui_frontend/index.html b/developer/webui/webui_frontend/index.html index 1eb0ea7b6a..a78580d6fd 100644 --- a/developer/webui/webui_frontend/index.html +++ b/developer/webui/webui_frontend/index.html @@ -9,11 +9,11 @@ - - + + -

    Developing the WebUI Frontend

    Notes on external frameworks​

    +

    Developing the WebUI Frontend

    Notes on external frameworks​

    The Rucio WebUI frontend uses two main frameworks: TailwindCSS and React. Both have excellent documentations, which I will not attempt to replace with these notes. Instead, I will extend them and concretise them @@ -300,6 +300,6 @@

    mockUseComDOM< which will raise Hydration Errors. This is because the page rendered on the server does not match the first render of the page on the client (because both use random fixture generators). However, you can choose to ignore the Hydration -Errors for the time being.

    Copyright © 2023 CERN
    +Errors for the time being.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/developer/webui/webui_frontend_vscode_dev_env/index.html b/developer/webui/webui_frontend_vscode_dev_env/index.html index 3c17e4b050..fc45645d98 100644 --- a/developer/webui/webui_frontend_vscode_dev_env/index.html +++ b/developer/webui/webui_frontend_vscode_dev_env/index.html @@ -9,11 +9,11 @@ - - + + -

    Setting up a WebUI Developer Environment using Visual Studio Code

    Different Usecases​

    +

    Setting up a WebUI Developer Environment using Visual Studio Code

    Different Usecases​

    There are different usecases when developing for the WebUI, this leads to varying requirements for the development environment. This guide will cover two usecases:

    @@ -85,6 +85,6 @@

    Edit this page
    Last updated on by Martin Barisits

    Copyright © 2023 CERN
    +secret/ account root under the VO Default.

    Copyright © 2023 CERN
    \ No newline at end of file diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 432a9ea474..09bc04d4ab 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -2264,7 +2264,7 @@ -
    Rucio logo
    API docs by Redocly
    Rucio logo
    API docs by Redocly
    Error handling

    Responses

    Request samples

    Content type
    application/json
    {
    • "identity": "string",
    • "authtype": "string"
    }

    Create identity

    Grant an account identity access to an account.

    +

    Request samples

    Content type
    application/json
    {
    • "identity": "string",
    • "authtype": "string"
    }

    List identities

    Lists all identities for an account.

    +
    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/accounts/{account}/identities \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • [
      ]
    ]

    Create identity

    Grant an account identity access to an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    Request Body schema: application/json
    identity
    required
    string

    The identity.

    authtype
    required
    string

    The authtype.

    @@ -2419,15 +2427,7 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "identity": "string",
    • "authtype": "string",
    • "email": "string",
    • "password": "none",
    • "default": false
    }

    Response samples

    Content type
    application/json
    "Created"

    List identities

    Lists all identities for an account.

    -
    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/accounts/{account}/identities \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • [
      ]
    ]

    List rules

    Lists all rules for an account.

    +

    Request samples

    Content type
    application/json
    {
    • "identity": "string",
    • "authtype": "string",
    • "email": "string",
    • "password": "none",
    • "default": false
    }

    Response samples

    Content type
    application/json
    "Created"

    List rules

    Lists all rules for an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    Responses

    Request samples 

    curl --request DELETE \
   --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Create

    Create an account.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    List account parameters

    Lists all parameters for an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    -
    Request Body schema: application/json
    type
    required
    string
    Enum: "USER" "GROUP" "SERVICE"

    The account type.

    -
    email
    required
    string

    The email for the account.

    -

    Responses

    Responses

    Request samples

    Content type
    application/json
    {
    • "type": "USER",
    • "email": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Update

    Update a parameter for an account.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/accounts/{account} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "account": "string",
    • "account_type": "string",
    • "status": "string",
    • "email": "string",
    • "suspended_at": "string",
    • "deleted_at": "string"
    }

    Update

    Update a parameter for an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    Request Body schema: application/json
    object

    Json object with key-value pairs corresponding to the new values of the parameters.

    Responses

    Request samples

    Content type
    application/json
    { }

    List account parameters

    Lists all parameters for an account.

    +

    Request samples

    Content type
    application/json
    { }

    Create

    Create an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account identifier.

    -

    Responses

    Request Body schema: application/json
    type
    required
    string
    Enum: "USER" "GROUP" "SERVICE"

    The account type.

    +
    email
    required
    string

    The email for the account.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "account": "string",
    • "account_type": "string",
    • "status": "string",
    • "email": "string",
    • "suspended_at": "string",
    • "deleted_at": "string"
    }

    List

    List all accounts.

    +

    Request samples

    Content type
    application/json
    {
    • "type": "USER",
    • "email": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    List

    List all accounts.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/accounts \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Auth

    UserPass Allow cross-site scripting

    UserPass Allow cross-site scripting. Explicit for Authentication.

    -
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/userpass \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    UserPass

    Authenticate a Rucio account temporarily via username and password.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Auth

    UserPass

    Authenticate a Rucio account temporarily via username and password.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string

    Account identifier as a string.

    X-Rucio-Username
    required
    string

    Username as a string.

    X-Rucio-Password
    required
    string

    password as a text-plain string.

    @@ -2511,109 +2506,109 @@

    Error handling

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/userpass \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
   --header 'X-Rucio-Password: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Username: SOME_STRING_VALUE'

    GSS Allow cross-site scripting

    GSS Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Username: SOME_STRING_VALUE'

    UserPass Allow cross-site scripting

    UserPass Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/gss \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    GSS

    Authenticate a Rucio account via GSS.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/userpass \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    GSS

    Authenticate a Rucio account via GSS.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    REMOTE_USER
    required
    string
    X-Rucio-AppID
    string
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/gss \
   --header 'REMOTE_USER: SOME_STRING_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    x509 Allow cross-site scripting

    x509 Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    GSS Allow cross-site scripting

    GSS Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/x509 \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    x509

    Authenticate a Rucio account via x509.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/gss \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    x509

    Authenticate a Rucio account via x509.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    X-Rucio-AppID
    string
    X-Forwarded-For
    string
    X-Rucio-Allow-Return-Multiple-Accounts
    boolean

    If set to true, a HTTP 206 response will be returned if the identity is associated with multiple accounts.

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/x509 \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-Allow-Return-Multiple-Accounts: SOME_BOOLEAN_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSH Allow cross-site scripting

    SSH Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    x509 Allow cross-site scripting

    x509 Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/ssh \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSH

    Authenticate a Rucio account via SSH.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/x509 \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSH

    Authenticate a Rucio account via SSH.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    X-Rucio-SSH-Signature
    required
    string
    X-Rucio-AppID
    string
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/ssh \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
-  --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'

    SSHChallengeToken Allow cross-site scripting

    SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'

    SSH Allow cross-site scripting

    SSH Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/ssh_challenge_token \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSHChallengeToken

    Authenticate a Rucio account via SSHChallengeToken.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/ssh \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSHChallengeToken

    Authenticate a Rucio account via SSHChallengeToken.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    X-Rucio-AppID
    string
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/ssh_challenge_token \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SAML Allow cross-site scripting

    SAML Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SSHChallengeToken Allow cross-site scripting

    SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/saml \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Post a SAML request

    Post a SAML request

    -
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request POST \
-  --url http://undefinedundefined/auth/saml \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SAML

    Authenticate a Rucio account via SAML.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/ssh_challenge_token \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SAML

    Authenticate a Rucio account via SAML.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    X-Rucio-AppID
    string
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/saml \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
   --header 'X-Rucio-AppID: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Validate Allow cross-site scripting

    Validate Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    SAML Allow cross-site scripting

    SAML Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/validate \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Validate

    Validate a Rucio auth token.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/saml \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Post a SAML request

    Post a SAML request

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request POST \
+  --url http://undefinedundefined/auth/saml \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Validate

    Validate a Rucio auth token.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/validate \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    OIDC Allow cross-site scripting

    OIDC Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Validate Allow cross-site scripting

    Validate Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    OIDC

    Authenticate a Rucio account via OIDC.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/validate \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    OIDC

    Authenticate a Rucio account via OIDC.

    Authorizations:
    AuthToken
    header Parameters
    HTTP_X_RUCIO_ACCOUNT
    string

    Account identifier as a string.

    HTTP_X_RUCIO_CLIENT_AUTHORIZE_SCOPE
    string
    HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUDIENCE
    string
    HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUTO
    string
    HTTP_X_RUCIO_CLIENT_AUTHORIZE_ISSUER
    string
    HTTP_X_RUCIO_CLIENT_AUTHORIZE_POLLING
    string
    HTTP_X_RUCIO_CLIENT_AUTHORIZE_REFRESH_LIFETIME
    string
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/oidc \
   --header 'HTTP_X_RUCIO_ACCOUNT: SOME_STRING_VALUE' \
   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUDIENCE: SOME_STRING_VALUE' \
@@ -2623,51 +2618,56 @@ 
    Error handling
    
   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_REFRESH_LIFETIME: SOME_STRING_VALUE' \
   --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_SCOPE: SOME_STRING_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    TokenOIDC Allow cross-site scripting

    TokenOIDC Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    OIDC Allow cross-site scripting

    OIDC Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_token \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    TokenOIDC

    Authenticate a Rucio account via TokenOIDC.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    TokenOIDC

    Authenticate a Rucio account via TokenOIDC.

    Authorizations:
    AuthToken
    header Parameters
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/oidc_token \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    CodeOIDC Allow cross-site scripting

    CodeOIDC Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    TokenOIDC Allow cross-site scripting

    TokenOIDC Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_code \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    CodeOIDC

    Authenticate a Rucio account via CodeOIDC.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_token \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    CodeOIDC

    Authenticate a Rucio account via CodeOIDC.

    Authorizations:
    AuthToken
    header Parameters
    X-Forwarded-For
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/oidc_code \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RedirectOIDC Allow cross-site scripting

    RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    CodeOIDC Allow cross-site scripting

    CodeOIDC Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_redirect \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RedirectOIDC

    Authenticate a Rucio account via RedirectOIDC.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_code \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RedirectOIDC

    Authenticate a Rucio account via RedirectOIDC.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Client-Fetch-Token
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/oidc_redirect \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \
-  --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'

    RefreshOIDC Allow cross-site scripting

    RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

    + --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'

    RedirectOIDC Allow cross-site scripting

    RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/auth/oidc_refresh \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RefreshOIDC

    Authenticate a Rucio account via RefreshOIDC.

    +

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_redirect \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RefreshOIDC

    Authenticate a Rucio account via RefreshOIDC.

    Authorizations:
    AuthToken
    header Parameters
    X-Rucio-Account
    required
    string
    X-Rucio-Auth-Token
    required
    string

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/auth/oidc_refresh \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    RefreshOIDC Allow cross-site scripting

    RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/auth/oidc_refresh \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Config

    Create value

    Create or set the value of an option.

    Authorizations:
    AuthToken
    path Parameters
    section
    required
    string

    The section.

    option
    required
    string

    The option of the section.

    @@ -2699,24 +2699,19 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "bytes": 0
    }

    Response samples

    Content type
    application/json
    { }

    Create

    Create or set the configuration option in the requested section.

    +

    Request samples

    Content type
    application/json
    {
    • "bytes": 0
    }

    Response samples

    Content type
    application/json
    { }

    List

    List the full configuration.

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/config \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Create

    Create or set the configuration option in the requested section.

    Authorizations:
    AuthToken
    Request Body schema: application/json
    object

    The request body is expected to contain a json {'section': {'option': 'value'}}.

    Responses

    Request samples

    Content type
    application/json
    { }

    Response samples

    Content type
    application/json
    "Created"

    List

    List the full configuration.

    -
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/config \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Credentials

    Cross-Site Scripting

    Allow cross-site scripting. Explicit for Authentication.

    -
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
-  --url http://undefinedundefined/credentials/signurl \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Sign URL

    Sign a url for a limited lifetime for a particular srevice.

    +

    Request samples

    Content type
    application/json
    { }

    Response samples

    Content type
    application/json
    "Created"

    Credentials

    Sign URL

    Sign a url for a limited lifetime for a particular srevice.

    Authorizations:
    AuthToken
    query Parameters
    rse
    required
    string

    The RSE to authenticate against.

    lifetime
    string

    The lifetime, default 600s.

    svc
    string

    The service, default gcs.

    @@ -2729,9 +2724,14 @@

    Error handling

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/credentials/signurl?rse=SOME_STRING_VALUE&lifetime=SOME_STRING_VALUE&svc=SOME_STRING_VALUE&op=SOME_STRING_VALUE&url=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Data Identifiers

    Get Data Identifier

    Return all data identifiers in the given scope.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Cross-Site Scripting

    Allow cross-site scripting. Explicit for Authentication.

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request OPTIONS \
+  --url http://undefinedundefined/credentials/signurl \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Data Identifiers

    Get Data Identifier

    Return all data identifiers in the given scope.

    Authorizations:
    AuthToken
    path Parameters
    scope
    required
    string

    The scope.

    query Parameters
    name
    string

    The name of the data identifier (did).

    recursive
    boolean

    If true, retrieves child identifiers recursively for non-file types.

    @@ -2800,7 +2800,15 @@

    Error handling

    Responses

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ]
    }

    Add dids to did

    Append data identifiers to data identifiers.

    +

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ]
    }

    Get did

    Returns the contents of a data identifier.

    +
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/dids/{scope_name}/dids \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Add dids to did

    Append data identifiers to data identifiers.

    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    Request Body schema: application/json
    rse
    string

    The name of the rse.

    account
    string

    The account which attaches the dids.

    @@ -2810,15 +2818,7 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "rse": "string",
    • "account": "string",
    • "dids": {
      }
    }

    Response samples

    Content type
    application/json
    "Created"

    Get did

    Returns the contents of a data identifier.

    -
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/dids/{scope_name}/dids \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Delete metadata

    Deletes the specified metadata from the did.

    +

    Request samples

    Content type
    application/json
    {
    • "rse": "string",
    • "account": "string",
    • "dids": {
      }
    }

    Response samples

    Content type
    application/json
    "Created"

    Delete metadata

    Deletes the specified metadata from the did.

    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    query Parameters
    key
    string

    The key to delete.

    Responses

    Request samples 

    curl --request DELETE \
   --url 'http://undefinedundefined/dids/{scope_name}/meta?key=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Add metadata

    Add metadata to a did.

    -
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    -
    Request Body schema: application/json
    meta
    required
    object

    The metadata to add. A dictionary containing the metadata name as key and the value as value.

    -
    recursive
    boolean
    Default: false

    Flag if the metadata should be applied recirsively to children.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "meta": { },
    • "recursive": false
    }

    Response samples

    Content type
    application/json
    "Created"

    Get metadata

    Get the metadata of a did.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Get metadata

    Get the metadata of a did.

    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    query Parameters
    plugin
    string
    Default: "DID_COLUMN"

    The plugin to use.

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/dids/{scope_name}/meta?plugin=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Add metadata

    Add metadata to a did.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Add metadata

    Add metadata to a did.

    +
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    +
    Request Body schema: application/json
    meta
    required
    object

    The metadata to add. A dictionary containing the metadata name as key and the value as value.

    +
    recursive
    boolean
    Default: false

    Flag if the metadata should be applied recirsively to children.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "meta": { },
    • "recursive": false
    }

    Response samples

    Content type
    application/json
    "Created"

    Add metadata

    Add metadata to a did.

    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    key
    required
    string

    The key for the metadata.

    Request Body schema: application/json
    value
    required
    object

    The value to set.

    @@ -2895,24 +2895,24 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "account": "string"
    }

    Post follow

    Mark the input DID as being followed by the given account.

    -
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    -
    Request Body schema: application/json
    account
    required
    string

    The account to follow the did.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "account": "string"
    }

    Get followers

    Get all followers for a specific did.

    +

    Request samples

    Content type
    application/json
    {
    • "account": "string"
    }

    Get followers

    Get all followers for a specific did.

    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    Responses

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/follow \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Add Dids bulk

    Add new Dids in bulk.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Post follow

    Mark the input DID as being followed by the given account.

    +
    Authorizations:
    AuthToken
    path Parameters
    scope_name
    required
    string

    The scope and the name of the did.

    +
    Request Body schema: application/json
    account
    required
    string

    The account to follow the did.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "account": "string"
    }

    Add Dids bulk

    Add new Dids in bulk.

    Authorizations:
    AuthToken
    Request Body schema: application/json
    Array
    scope
    required
    string

    The did scope.

    name
    required
    string

    The did name.

    type
    required
    string
    Enum: "F" "D" "C" "A" "X" "Y" "Z"

    The type of the did.

    @@ -3014,7 +3014,13 @@

    Error handling

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/export?distance=SOME_BOOLEAN_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Heartbeat

    Create

    Authorizations:
    AuthToken
    Request Body schema: application/json
    executable
    string

    Name of the executable.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    { }

    Heartbeat

    List

    List all heartbeats.

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/heartbeats \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • { }
    ]

    Create

    Authorizations:
    AuthToken
    Request Body schema: application/json
    executable
    string

    Name of the executable.

    hostname
    string

    Name of the host.

    pid
    integer

    UNIX Process ID as a number, e.g., 1234.

    older_than
    integer

    Ignore specified heartbeats older than specified nr of seconds.

    @@ -3023,13 +3029,7 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "executable": "string",
    • "hostname": "string",
    • "pid": 0,
    • "older_than": 0,
    • "payload": "string"
    }

    List

    List all heartbeats.

    -
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/heartbeats \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • { }
    ]

    Identity

    Create UserPass identity

    Creates a new UserPass identity and maps it to an account.

    +

    Request samples

    Content type
    application/json
    {
    • "executable": "string",
    • "hostname": "string",
    • "pid": 0,
    • "older_than": 0,
    • "payload": "string"
    }

    Identity

    Create UserPass identity

    Creates a new UserPass identity and maps it to an account.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account for the identity.

    query Parameters
    X-Rucio-Username
    required
    string

    Username for the identity.

    X-Rucio-Password
    required
    string

    The password for the identity.

    @@ -3066,7 +3066,14 @@

    Error handling

    Array of objects

    Account data.

    Responses

    Request samples

    Content type
    application/json
    {
    • "rses": {
      },
    • "distances": {
      },
    • "accounts": [
      ]
    }

    Response samples

    Content type
    application/json
    "Created"

    Lifetime Exceptions

    Create Exception

    Creates a Lifetime Exception.

    +

    Request samples

    Content type
    application/json
    {
    • "rses": {
      },
    • "distances": {
      },
    • "accounts": [
      ]
    }

    Response samples

    Content type
    application/json
    "Created"

    Lifetime Exceptions

    List Exceptions

    Retrieves all exceptions.

    +
    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/lifetime_exceptions/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Create Exception

    Creates a Lifetime Exception.

    Authorizations:
    AuthToken
    Request Body schema: application/json
    Array of objects

    List of dids associated with the lifetime exception.

    pattern
    string

    The pattern of the lifetime exception.

    comments
    string

    The comment for the lifetime exception.

    @@ -3075,29 +3082,22 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "pattern": "string",
    • "comments": "string",
    • "expires_at": "string"
    }

    Response samples

    Content type
    application/json
    "string"

    List Exceptions

    Retrieves all exceptions.

    -
    Authorizations:
    AuthToken

    Responses

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "pattern": "string",
    • "comments": "string",
    • "expires_at": "string"
    }

    Response samples

    Content type
    application/json
    "string"

    Get Exception

    Get a single Lifetime Exception.

    +
    Authorizations:
    AuthToken
    path Parameters
    exception_id
    required
    string

    The id of the lifetime exception.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/lifetime_exceptions/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Approve/Reject exception

    Approve/Reject a Lifetime Exception.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/lifetime_exceptions/{exception_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Approve/Reject exception

    Approve/Reject a Lifetime Exception.

    Authorizations:
    AuthToken
    path Parameters
    exception_id
    required
    string

    The id of the Lifetime Exception.

    Request Body schema: application/json
    state
    string
    Enum: "A" "R"

    The new state for the Lifetime Exception.

    Responses

    Request samples

    Content type
    application/json
    {
    • "state": "A"
    }

    Response samples

    Content type
    application/json
    "Created"

    Get Exception

    Get a single Lifetime Exception.

    -
    Authorizations:
    AuthToken
    path Parameters
    exception_id
    required
    string

    The id of the lifetime exception.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/lifetime_exceptions/{exception_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Lock

    Get locks by rse

    Get all dataset locks for an associated rse.

    +

    Request samples

    Content type
    application/json
    {
    • "state": "A"
    }

    Response samples

    Content type
    application/json
    "Created"

    Lock

    Get locks by rse

    Get all dataset locks for an associated rse.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The rse name.

    Request Body schema: application/json
    did_type
    string
    Value: "dataset"

    The did type to filter for.

    Responses

    Request samples

    Content type
    application/json
    {
    • "key_type": "string",
    • "value_type": "string",
    • "value_regexp": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Create value for key

    Creates a new value for a key.

    +

    Request samples

    Content type
    application/json
    {
    • "key_type": "string",
    • "value_type": "string",
    • "value_regexp": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Get value for key

    List all values for a key.

    +
    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/meta_conventions/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Create value for key

    Creates a new value for a key.

    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    Request Body schema: application/json
    value
    required
    string

    The new value associated with a key.

    Responses

    Request samples

    Content type
    application/json
    {
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Get value for key

    List all values for a key.

    -
    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/meta_conventions/{key}/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Create key

    Creates a new allowed key (value is NULL).

    +

    Request samples

    Content type
    application/json
    {
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Create key

    Creates a new allowed key (value is NULL).

    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The name of the key.

    Request Body schema: application/json
    key_type
    string

    The key type.

    value_type
    string

    The value type.

    @@ -3150,7 +3150,14 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "key_type": "string",
    • "value_type": "string",
    • "value_regexp": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Create value for key

    Creates a new value for a key.

    +

    Request samples

    Content type
    application/json
    {
    • "key_type": "string",
    • "value_type": "string",
    • "value_regexp": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Get value for key

    List all values for a key.

    +
    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/meta/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Create value for key

    Creates a new value for a key.

    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    Request Body schema: application/json
    value
    required
    string

    The new value associated with a key.

    Responses

    Request samples

    Content type
    application/json
    {
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Get value for key

    List all values for a key.

    -
    Authorizations:
    AuthToken
    path Parameters
    key
    required
    string

    The reference key.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/meta/{key}/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Ping

    Ping

    Ping the server and get data about it.

    +

    Request samples

    Content type
    application/json
    {
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    "Created"

    Ping

    Ping

    Ping the server and get data about it.

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
@@ -3225,14 +3225,7 @@ 
    Error handling

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/replicas/{scope_name}?schemes=SOME_STRING_VALUE&select=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Declare Suspicious Replicas

    Declare a list of suspicious replicas.

    -
    Authorizations:
    AuthToken
    Request Body schema: application/json
    pfns
    Array of strings

    The list of pfns.

    -
    reason
    string

    The reason for the declaration.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "pfns": [
      ],
    • "reason": "string"
    }

    Response samples

    Content type
    application/json
    [ ]

    List Suspicious Replicas

    List the suspicious replicas on a list of RSEs.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    List Suspicious Replicas

    List the suspicious replicas on a list of RSEs.

    Authorizations:
    AuthToken
    query Parameters
    rse_expression
    string

    The RSE expression to filter for.

    younger_than
    string

    Date to filter for.

    nattempts
    integer

    The maximum number of attempts to make.

    @@ -3240,9 +3233,16 @@

    Error handling

    Request samples 

    curl --request GET \
+

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/replicas/suspicious?rse_expression=SOME_STRING_VALUE&younger_than=SOME_STRING_VALUE&nattempts=SOME_INTEGER_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    List Bad Replicas By States

    List the bad or suspicious replicas by states.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Declare Suspicious Replicas

    Declare a list of suspicious replicas.

    +
    Authorizations:
    AuthToken
    Request Body schema: application/json
    pfns
    Array of strings

    The list of pfns.

    +
    reason
    string

    The reason for the declaration.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "pfns": [
      ],
    • "reason": "string"
    }

    Response samples

    Content type
    application/json
    [ ]

    List Bad Replicas By States

    List the bad or suspicious replicas by states.

    Authorizations:
    AuthToken
    query Parameters
    state
    string
    Enum: "SUSPICIOUS" "BAD"

    The state of the file.

    rse
    string

    The rse name.

    younger_than
    string <date-time>

    Date to select bad replicas younger than this date.

    @@ -3371,16 +3371,16 @@

    Error handling

    Request samples 

    curl --request GET \
   --url 'http://undefinedundefined/subscriptions/{account}/{name}/rules?state=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • null
    ]

    Create subscription

    Create a new subscription

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • null
    ]

    Get Subscription

    Retrieve a subscription.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account name.

    name
    required
    string

    The subscription name.

    -
    Request Body schema: application/json
    required
    object

    The values for the new subscription.

    -

    Responses

    Responses

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Response samples

    Content type
    application/json
    "string"

    Update subscription

    Update an existing subscription.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/subscriptions/{account}/{name} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Update subscription

    Update an existing subscription.

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account name.

    name
    required
    string

    The subscription name.

    Request Body schema: application/json
    required
    object

    The values for the new subscription.

    @@ -3388,16 +3388,16 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Get Subscription

    Retrieve a subscription.

    +

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Create subscription

    Create a new subscription

    Authorizations:
    AuthToken
    path Parameters
    account
    required
    string

    The account name.

    name
    required
    string

    The subscription name.

    -

    Responses

    Request Body schema: application/json
    required
    object

    The values for the new subscription.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/subscriptions/{account}/{name} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Get Subscription by Name

    Retrieve a subscription by name.

    +

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Response samples

    Content type
    application/json
    "string"

    Get Subscription by Name

    Retrieve a subscription by name.

    Authorizations:
    AuthToken
    path Parameters
    name
    required
    string

    The subscription name.

    Responses

    Request samples 

    curl --request DELETE \
   --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "Deleted"

    Create Rse Distance

    Post a rse distance.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "Deleted"

    Get Rse Distances

    Returns the distances between a source and destination rse.

    Authorizations:
    AuthToken
    path Parameters
    source
    required
    string

    The name of the source Rucio Storage Element.

    destination
    required
    string

    The name of the destination Rucio Storage Element.

    -
    Request Body schema: application/json
    distance
    integer

    The distance between RSEs.

    -
    ranking
    integer
    Deprecated

    Same as distance.

    -

    Responses

    Responses

    Request samples

    Content type
    application/json
    {
    • "distance": 0,
    • "ranking": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Update Rse Distance

    Update rse distance information.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rses/{source}/distances/{destination} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Update Rse Distance

    Update rse distance information.

    Authorizations:
    AuthToken
    path Parameters
    source
    required
    string

    The name of the source Rucio Storage Element.

    destination
    required
    string

    The name of the destination Rucio Storage Element.

    Request Body schema: application/json
    distance
    integer

    The distance between the RSEs.

    @@ -3502,16 +3502,16 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "distance": 0,
    • "ranking": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Get Rse Distances

    Returns the distances between a source and destination rse.

    +

    Request samples

    Content type
    application/json
    {
    • "distance": 0,
    • "ranking": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Create Rse Distance

    Post a rse distance.

    Authorizations:
    AuthToken
    path Parameters
    source
    required
    string

    The name of the source Rucio Storage Element.

    destination
    required
    string

    The name of the destination Rucio Storage Element.

    -

    Responses

    Request Body schema: application/json
    distance
    integer

    The distance between RSEs.

    +
    ranking
    integer
    Deprecated

    Same as distance.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Delete Protocol Attributes

    Delete all protocol attributes.

    +

    Request samples

    Content type
    application/json
    {
    • "distance": 0,
    • "ranking": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Delete Protocol Attributes

    Delete all protocol attributes.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    scheme
    required
    string

    The protocol identifier.

    hostname
    required
    string

    The hostname of the protocol.

    @@ -3560,7 +3560,17 @@

    Error handling

    Request samples 

    curl --request GET \
   --url http://undefinedundefined/rses/{rse}/accounts/usage \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Update Rse Usage

    Update the RSE Update information.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Get Rse Usage Information

    Get rse usage information.

    +
    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    +
    query Parameters
    per_account
    boolean

    Boolean whether the usage should be also calculated per account or not.

    +
    source
    string

    The information source, e.g., srm.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Update Rse Usage

    Update the RSE Update information.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    Request Body schema: application/json
    source
    string

    The information source, e.g. srm.

    used
    integer

    The number of used bytes.

    @@ -3571,17 +3581,7 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "source": "string",
    • "used": 0,
    • "free": 0,
    • "files": 0
    }

    Get Rse Usage Information

    Get rse usage information.

    -
    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    -
    query Parameters
    per_account
    boolean

    Boolean whether the usage should be also calculated per account or not.

    -
    source
    string

    The information source, e.g., srm.

    -

    Responses

    Request samples 

    curl --request GET \
-  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/x-json-stream
    [
    • {
      }
    ]

    Get Rse Usage History

    Get the rse usage history

    +

    Request samples

    Content type
    application/json
    {
    • "source": "string",
    • "used": 0,
    • "free": 0,
    • "files": 0
    }

    Get Rse Usage History

    Get the rse usage history

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Update Rse Limit

    Update an rse limit.

    +

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Get Rse Limits

    Get the rse limits.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    -
    Request Body schema: application/json
    name
    string

    The name of the limit.

    -
    value
    integer

    The value of the limit.

    -

    Responses

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "value": 0
    }

    Get Rse Limits

    Get the rse limits.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rses/{rse}/limits \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "limit name1": 0,
    • "limit name2": 0
    }

    Update Rse Limit

    Update an rse limit.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    -

    Responses

    Request Body schema: application/json
    name
    string

    The name of the limit.

    +
    value
    integer

    The value of the limit.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rses/{rse}/limits \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "limit name1": 0,
    • "limit name2": 0
    }

    Delete QoS Policy

    Delete QoS policy from RSE.

    +

    Request samples

    Content type
    application/json
    {
    • "name": "string",
    • "value": 0
    }

    Delete QoS Policy

    Delete QoS policy from RSE.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    policy
    required
    string

    The QoS policy to add to and rse.

    Responses

    Request samples 

    curl --request DELETE \
   --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Create RSE

    Creates a RSE with all the metadata.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Get RSE

    Get details about a specific RSE.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    -
    Request Body schema: application/json
    deterministic
    boolean

    If the pfn is generated deterministicly.

    -
    volatile
    boolean

    RSE cache.

    -
    city
    string

    The city of the RSE.

    -
    staging_area
    string

    Staging area.

    -
    region_code
    string

    The region code of the RSE.

    -
    country_name
    string

    The country name of the RSE.

    -
    continent
    string

    The continent of the RSE.

    -
    time_zone
    string

    The time zone of the RSE.

    -
    ISP
    string

    The internet service provider of the RSE.

    -
    rse_type
    string
    Enum: "DISK" "TAPE"

    The rse type.

    -
    latitude
    number

    The latitude of the RSE.

    -
    longitude
    number

    The longitude of the RSE.

    -
    ASN
    string

    The access service network of the RSE.

    -
    availability
    integer
    Deprecated

    The availability of the RSE.

    -
    availability_read
    boolean

    If the RSE is readable.

    -
    availability_write
    boolean

    If the RSE is writable.

    -
    availability_delete
    boolean

    If the RSE is deletable.

    -

    Responses

    Responses

    Request samples

    Content type
    application/json
    {
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "continent": "string",
    • "time_zone": "string",
    • "ISP": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0,
    • "ASN": "string",
    • "availability": 0,
    • "availability_read": true,
    • "availability_write": true,
    • "availability_delete": true
    }

    Response samples

    Content type
    application/json
    "Created"

    Update RSE

    Update RSE properties.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rses/{rse} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "continent": "string",
    • "time_zone": "string",
    • "ISP": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0,
    • "ASN": "string",
    • "availability": 0,
    • "availability_read": 0,
    • "availability_write": 0,
    • "availability_delete": null
    }

    Update RSE

    Update RSE properties.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    Request Body schema: application/json
    availability_read
    boolean

    The vailability of the RSE.

    availability_write
    boolean

    The vailability of the RSE.

    @@ -3680,15 +3664,31 @@

    Error handling

    Request samples

    Content type
    application/json
    {
    • "availability_read": true,
    • "availability_write": true,
    • "availability_delete": true,
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "time_zone": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Get RSE

    Get details about a specific RSE.

    +

    Request samples

    Content type
    application/json
    {
    • "availability_read": true,
    • "availability_write": true,
    • "availability_delete": true,
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "time_zone": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0
    }

    Response samples

    Content type
    application/json
    "Created"

    Create RSE

    Creates a RSE with all the metadata.

    Authorizations:
    AuthToken
    path Parameters
    rse
    required
    string

    The name of the Rucio Storage Element name.

    -

    Responses

    Request Body schema: application/json
    deterministic
    boolean

    If the pfn is generated deterministicly.

    +
    volatile
    boolean

    RSE cache.

    +
    city
    string

    The city of the RSE.

    +
    staging_area
    string

    Staging area.

    +
    region_code
    string

    The region code of the RSE.

    +
    country_name
    string

    The country name of the RSE.

    +
    continent
    string

    The continent of the RSE.

    +
    time_zone
    string

    The time zone of the RSE.

    +
    ISP
    string

    The internet service provider of the RSE.

    +
    rse_type
    string
    Enum: "DISK" "TAPE"

    The rse type.

    +
    latitude
    number

    The latitude of the RSE.

    +
    longitude
    number

    The longitude of the RSE.

    +
    ASN
    string

    The access service network of the RSE.

    +
    availability
    integer
    Deprecated

    The availability of the RSE.

    +
    availability_read
    boolean

    If the RSE is readable.

    +
    availability_write
    boolean

    If the RSE is writable.

    +
    availability_delete
    boolean

    If the RSE is deletable.

    +

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    {
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "continent": "string",
    • "time_zone": "string",
    • "ISP": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0,
    • "ASN": "string",
    • "availability": 0,
    • "availability_read": 0,
    • "availability_write": 0,
    • "availability_delete": null
    }

    List RSEs

    Lists all RSEs.

    +

    Request samples

    Content type
    application/json
    {
    • "deterministic": true,
    • "volatile": true,
    • "city": "string",
    • "staging_area": "string",
    • "region_code": "string",
    • "country_name": "string",
    • "continent": "string",
    • "time_zone": "string",
    • "ISP": "string",
    • "rse_type": "DISK",
    • "latitude": 0,
    • "longitude": 0,
    • "ASN": "string",
    • "availability": 0,
    • "availability_read": true,
    • "availability_write": true,
    • "availability_delete": true
    }

    Response samples

    Content type
    application/json
    "Created"

    List RSEs

    Lists all RSEs.

    Authorizations:
    AuthToken
    query Parameters
    expression
    string

    RSE expression to select RSEs.

    Responses

    Request samples 

    curl --request DELETE \
   --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Update the replication rules parameters

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    + --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Return a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    +

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rules/{rule_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Update the replication rules parameters

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    Request Body schema: application/json

    Parameters for the new rule.

    required
    object

    The parameters to change.

    Responses

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Return a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "options": {
      }
    }

    Return all rules for a given account

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Create a new replication rule

    Authorizations:
    AuthToken
    Request Body schema: application/json

    Parameters for the new rule.

    +

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rules/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Create a new replication rule

    Authorizations:
    AuthToken
    Request Body schema: application/json

    Parameters for the new rule.

    required
    Array of objects

    The list of data identifiers.

    account
    required
    string

    The account of the issuer.

    copies
    required
    integer

    The number of replicas.

    @@ -3752,13 +3758,7 @@

    Error handling

  • Manual Rule Approval Blocked
  • Invalid Object
    • -

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all rules for a given account

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
-  --url http://undefinedundefined/rules/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    +

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    Responses

    Response samples

    Content type
    application/json
    [
    • "string"
    ]
    + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + +

    404 - Not found

    + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/html/site/assets/_mkdocstrings.css b/html/site/assets/_mkdocstrings.css new file mode 100644 index 0000000000..b500381b5c --- /dev/null +++ b/html/site/assets/_mkdocstrings.css @@ -0,0 +1,143 @@ + +/* Avoid breaking parameter names, etc. in table cells. */ +.doc-contents td code { + word-break: normal !important; +} + +/* No line break before first paragraph of descriptions. */ +.doc-md-description, +.doc-md-description>p:first-child { + display: inline; +} + +/* Max width for docstring sections tables. */ +.doc .md-typeset__table, +.doc .md-typeset__table table { + display: table !important; + width: 100%; +} + +.doc .md-typeset__table tr { + display: table-row; +} + +/* Defaults in Spacy table style. */ +.doc-param-default { + float: right; +} + +/* Parameter headings must be inline, not blocks. */ +.doc-heading-parameter { + display: inline; +} + +/* Prefer space on the right, not the left of parameter permalinks. */ +.doc-heading-parameter .headerlink { + margin-left: 0 !important; + margin-right: 0.2rem; +} + +/* Backward-compatibility: docstring section titles in bold. */ +.doc-section-title { + font-weight: bold; +} + +/* Symbols in Navigation and ToC. */ +:root, :host, +[data-md-color-scheme="default"] { + --doc-symbol-parameter-fg-color: #df50af; + --doc-symbol-attribute-fg-color: #953800; + --doc-symbol-function-fg-color: #8250df; + --doc-symbol-method-fg-color: #8250df; + --doc-symbol-class-fg-color: #0550ae; + --doc-symbol-module-fg-color: #5cad0f; + + --doc-symbol-parameter-bg-color: #df50af1a; + --doc-symbol-attribute-bg-color: #9538001a; + --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-method-bg-color: #8250df1a; + --doc-symbol-class-bg-color: #0550ae1a; + --doc-symbol-module-bg-color: #5cad0f1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-parameter-fg-color: #ffa8cc; + --doc-symbol-attribute-fg-color: #ffa657; + --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-method-fg-color: #d2a8ff; + --doc-symbol-class-fg-color: #79c0ff; + --doc-symbol-module-fg-color: #baff79; + + --doc-symbol-parameter-bg-color: #ffa8cc1a; + --doc-symbol-attribute-bg-color: #ffa6571a; + --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-method-bg-color: #d2a8ff1a; + --doc-symbol-class-bg-color: #79c0ff1a; + --doc-symbol-module-bg-color: #baff791a; +} + +code.doc-symbol { + border-radius: .1rem; + font-size: .85em; + padding: 0 .3em; + font-weight: bold; +} + +code.doc-symbol-parameter { + color: var(--doc-symbol-parameter-fg-color); + background-color: var(--doc-symbol-parameter-bg-color); +} + +code.doc-symbol-parameter::after { + content: "param"; +} + +code.doc-symbol-attribute { + color: var(--doc-symbol-attribute-fg-color); + background-color: var(--doc-symbol-attribute-bg-color); +} + +code.doc-symbol-attribute::after { + content: "attr"; +} + +code.doc-symbol-function { + color: var(--doc-symbol-function-fg-color); + background-color: var(--doc-symbol-function-bg-color); +} + +code.doc-symbol-function::after { + content: "func"; +} + +code.doc-symbol-method { + color: var(--doc-symbol-method-fg-color); + background-color: var(--doc-symbol-method-bg-color); +} + +code.doc-symbol-method::after { + content: "meth"; +} + +code.doc-symbol-class { + color: var(--doc-symbol-class-fg-color); + background-color: var(--doc-symbol-class-bg-color); +} + +code.doc-symbol-class::after { + content: "class"; +} + +code.doc-symbol-module { + color: var(--doc-symbol-module-fg-color); + background-color: var(--doc-symbol-module-bg-color); +} + +code.doc-symbol-module::after { + content: "mod"; +} + +.doc-signature .autorefs { + color: inherit; + border-bottom: 1px dotted currentcolor; +} diff --git a/html/site/assets/images/favicon.png b/html/site/assets/images/favicon.png new file mode 100644 index 0000000000..1cf13b9f9d Binary files /dev/null and b/html/site/assets/images/favicon.png differ diff --git a/html/site/assets/javascripts/bundle.83f73b43.min.js b/html/site/assets/javascripts/bundle.83f73b43.min.js new file mode 100644 index 0000000000..43d8b70f69 --- /dev/null +++ b/html/site/assets/javascripts/bundle.83f73b43.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Wi=Object.create;var gr=Object.defineProperty;var Di=Object.getOwnPropertyDescriptor;var Vi=Object.getOwnPropertyNames,Vt=Object.getOwnPropertySymbols,Ni=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,ao=Object.prototype.propertyIsEnumerable;var io=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,$=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&io(e,r,t[r]);if(Vt)for(var r of Vt(t))ao.call(t,r)&&io(e,r,t[r]);return e};var so=(e,t)=>{var r={};for(var o in e)yr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Vt)for(var o of Vt(e))t.indexOf(o)<0&&ao.call(e,o)&&(r[o]=e[o]);return r};var xr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var zi=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Vi(t))!yr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=Di(t,n))||o.enumerable});return e};var Mt=(e,t,r)=>(r=e!=null?Wi(Ni(e)):{},zi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var co=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var lo=xr((Er,po)=>{(function(e,t){typeof Er=="object"&&typeof po!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function p(k){var ft=k.type,qe=k.tagName;return!!(qe==="INPUT"&&a[ft]&&!k.readOnly||qe==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function c(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(k){o=!1}function d(k){s(k.target)&&(o||p(k.target))&&c(k.target)}function y(k){s(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function L(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function te(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,te())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",L,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",y,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var qr=xr((hy,On)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var $a=/["'&<>]/;On.exports=Pa;function Pa(e){var t=""+e,r=$a.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof It=="object"&&typeof Yr=="object"?Yr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof It=="object"?It.ClipboardJS=r():t.ClipboardJS=r()})(It,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ui}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(A){return!1}}var d=function(A){var M=f()(A);return u("cut"),M},y=d;function L(V){var A=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[A?"right":"left"]="-9999px";var F=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(F,"px"),M.setAttribute("readonly",""),M.value=V,M}var X=function(A,M){var F=L(A);M.container.appendChild(F);var D=f()(F);return u("copy"),F.remove(),D},te=function(A){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},F="";return typeof A=="string"?F=X(A,M):A instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(A==null?void 0:A.type)?F=X(A.value,M):(F=f()(A),u("copy")),F},J=te;function k(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(M){return typeof M}:k=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},k(V)}var ft=function(){var A=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=A.action,F=M===void 0?"copy":M,D=A.container,Y=A.target,$e=A.text;if(F!=="copy"&&F!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&k(Y)==="object"&&Y.nodeType===1){if(F==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(F==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if($e)return J($e,{container:D});if(Y)return F==="cut"?y(Y):J(Y,{container:D})},qe=ft;function Fe(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Fe=function(M){return typeof M}:Fe=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Fe(V)}function ki(V,A){if(!(V instanceof A))throw new TypeError("Cannot call a class as a function")}function no(V,A){for(var M=0;M0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Fe(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function($e){return Y.onClick($e)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,$e=this.action(Y)||"copy",Dt=qe({action:$e,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Dt?"success":"error",{action:$e,text:Dt,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return y(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,$e=!!document.queryCommandSupported;return Y.forEach(function(Dt){$e=$e&&!!document.queryCommandSupported(Dt)}),$e}}]),M}(s()),Ui=Fi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,d,y){var L=c.apply(this,arguments);return l.addEventListener(u,L,y),{destroy:function(){l.removeEventListener(u,L,y)}}}function p(l,f,u,d,y){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(L){return s(L,f,u,d,y)}))}function c(l,f,u,d){return function(y){y.delegateTarget=a(y.target,f),y.delegateTarget&&d.call(l,y)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,d,y){if(!u&&!d&&!y)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(y))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,d,y);if(a.nodeList(u))return l(u,d,y);if(a.string(u))return f(u,d,y);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,d,y){return u.addEventListener(d,y),{destroy:function(){u.removeEventListener(d,y)}}}function l(u,d,y){return Array.prototype.forEach.call(u,function(L){L.addEventListener(d,y)}),{destroy:function(){Array.prototype.forEach.call(u,function(L){L.removeEventListener(d,y)})}}}function f(u,d,y){return s(document.body,u,d,y)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||p(d,L)})},y&&(n[d]=y(n[d])))}function p(d,y){try{c(o[d](y))}catch(L){u(i[0][3],L)}}function c(d){d.value instanceof nt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){p("next",d)}function f(d){p("throw",d)}function u(d,y){d(y),i.shift(),i.length&&p(i[0][0],i[0][1])}}function uo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof he=="function"?he(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function H(e){return typeof e=="function"}function ut(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ut(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ue=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=he(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(L){t={error:L}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(H(l))try{l()}catch(L){i=L instanceof zt?L.errors:[L]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=he(f),d=u.next();!d.done;d=u.next()){var y=d.value;try{ho(y)}catch(L){i=i!=null?i:[],L instanceof zt?i=q(q([],N(i)),N(L.errors)):i.push(L)}}}catch(L){o={error:L}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ho(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Ue.EMPTY;function qt(e){return e instanceof Ue||e&&"closed"in e&&H(e.remove)&&H(e.add)&&H(e.unsubscribe)}function ho(e){H(e)?e():e.unsubscribe()}var Pe={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var dt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Ue(function(){o.currentObservers=null,Qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new To(r,o)},t}(j);var To=function(e){oe(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){oe(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var At={now:function(){return(At.delegate||Date).now()},delegate:void 0};var Ct=function(e){oe(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=At);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(gt);var Lo=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(yt);var kr=new Lo(Oo);var Mo=function(e){oe(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=vt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(vt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(gt);var _o=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(yt);var me=new _o(Mo);var S=new j(function(e){return e.complete()});function Yt(e){return e&&H(e.schedule)}function Hr(e){return e[e.length-1]}function Xe(e){return H(Hr(e))?e.pop():void 0}function ke(e){return Yt(Hr(e))?e.pop():void 0}function Bt(e,t){return typeof Hr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return H(e==null?void 0:e.then)}function Jt(e){return H(e[bt])}function Xt(e){return Symbol.asyncIterator&&H(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Zi();function tr(e){return H(e==null?void 0:e[er])}function rr(e){return fo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return H(e==null?void 0:e.getReader)}function U(e){if(e instanceof j)return e;if(e!=null){if(Jt(e))return ea(e);if(xt(e))return ta(e);if(Gt(e))return ra(e);if(Xt(e))return Ao(e);if(tr(e))return oa(e);if(or(e))return na(e)}throw Zt(e)}function ea(e){return new j(function(t){var r=e[bt]();if(H(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function ta(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?De(t):Qo(function(){return new ir}))}}function jr(e){return e<=0?function(){return S}:E(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,d=0,y=!1,L=!1,X=function(){f==null||f.unsubscribe(),f=void 0},te=function(){X(),l=u=void 0,y=L=!1},J=function(){var k=l;te(),k==null||k.unsubscribe()};return E(function(k,ft){d++,!L&&!y&&X();var qe=u=u!=null?u:r();ft.add(function(){d--,d===0&&!L&&!y&&(f=Ur(J,p))}),qe.subscribe(ft),!l&&d>0&&(l=new at({next:function(Fe){return qe.next(Fe)},error:function(Fe){L=!0,X(),f=Ur(te,n,Fe),qe.error(Fe)},complete:function(){y=!0,X(),f=Ur(te,a),qe.complete()}}),U(k).subscribe(l))})(c)}}function Ur(e,t){for(var r=[],o=2;oe.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function R(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Ie(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var wa=O(h(document.body,"focusin"),h(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Ie()||document.body),G(1));function et(e){return wa.pipe(m(t=>e.contains(t)),K())}function $t(e,t){return C(()=>O(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Le(+!r*t)):le,Q(e.matches(":hover"))))}function Jo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Jo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Jo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function Tt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),O(h(t,"load"),h(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),Te(1))))}var Xo=new g,Ta=C(()=>typeof ResizeObserver=="undefined"?Tt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Xo.next(t)))),v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ta.pipe(w(r=>r.observe(t)),v(r=>Xo.pipe(b(o=>o.target===t),_(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function St(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Zo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ve(e){return{x:e.offsetLeft,y:e.offsetTop}}function en(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function tn(e){return O(h(window,"load"),h(window,"resize")).pipe(Me(0,me),m(()=>Ve(e)),Q(Ve(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ne(e){return O(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe(Me(0,me),m(()=>pr(e)),Q(pr(e)))}var rn=new g,Sa=C(()=>I(new IntersectionObserver(e=>{for(let t of e)rn.next(t)},{threshold:0}))).pipe(v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function tt(e){return Sa.pipe(w(t=>t.observe(e)),v(t=>rn.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function on(e,t=16){return Ne(e).pipe(m(({y:r})=>{let o=ce(e),n=St(e);return r>=n.height-o.height-t}),K())}var lr={drawer:R("[data-md-toggle=drawer]"),search:R("[data-md-toggle=search]")};function nn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function ze(e){let t=lr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function Oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function La(){return O(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function an(){let e=h(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:nn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Ie();if(typeof o!="undefined")return!Oa(o,r)}return!0}),pe());return La().pipe(v(t=>t?S:e))}function ye(){return new URL(location.href)}function lt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function sn(){return new g}function cn(){return location.hash.slice(1)}function pn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Ma(e){return O(h(window,"hashchange"),e).pipe(m(cn),Q(cn()),b(t=>t.length>0),G(1))}function ln(e){return Ma(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function Pt(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function mn(){let e=matchMedia("print");return O(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():S))}function zr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function je(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function fn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function un(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function dn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function hn(){return O(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(dn),Q(dn()))}function bn(){return{width:innerWidth,height:innerHeight}}function vn(){return h(window,"resize",{passive:!0}).pipe(m(bn),Q(bn()))}function gn(){return z([hn(),vn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(ee("size")),n=z([o,r]).pipe(m(()=>Ve(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function _a(e){return h(e,"message",t=>t.data)}function Aa(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function yn(e,t=new Worker(e)){let r=_a(t),o=Aa(t),n=new g;n.subscribe(o);let i=o.pipe(Z(),ie(!0));return n.pipe(Z(),Re(r.pipe(W(i))),pe())}var Ca=R("#__config"),Ot=JSON.parse(Ca.textContent);Ot.base=`${new URL(Ot.base,ye())}`;function xe(){return Ot}function B(e){return Ot.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?Ot.translations[e].replace("#",t.toString()):Ot.translations[e]}function Se(e,t=document){return R(`[data-md-component=${e}]`,t)}function ae(e,t=document){return P(`[data-md-component=${e}]`,t)}function ka(e){let t=R(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>R(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function xn(e){if(!B("announce.dismiss")||!e.childElementCount)return S;if(!e.hidden){let t=R(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),ka(e).pipe(w(r=>t.next(r)),_(()=>t.complete()),m(r=>$({ref:e},r)))})}function Ha(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function En(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Ha(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))}function Rt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Tn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Sn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}var Ln=Mt(qr());function Qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,(0,Ln.default)(c))," "],[]).slice(0,-1),i=xe(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=xe();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Mn(e){let t=e[0].score,r=[...e],o=xe(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreQr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>Qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function _n(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Kr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function An(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ra(e){var o;let t=xe(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Cn(e,t){var o;let r=xe();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ra)))}var Ia=0;function ja(e){let t=z([et(e),$t(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Zo(e)).pipe(ne(Ne),pt(1),He(t),m(()=>en(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function Fa(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ia++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(Z(),ie(!1)).subscribe(a);let s=a.pipe(Ht(c=>Le(+!c*250,kr)),K(),v(c=>c?r:S),w(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>$t(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),re(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),d=u.width/2;if(l.role==="tooltip")return{x:d,y:8+u.height};if(u.y>=f.height/2){let{height:y}=ce(l);return{x:d,y:-16-y}}else return{x:d,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),re(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(R(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),ve(me),re(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ja(e).pipe(w(c=>i.next(c)),_(()=>i.complete()),m(c=>$({ref:e},c)))})}function mt(e,{viewport$:t},r=document.body){return Fa(e,{content$:new j(o=>{let n=e.title,i=wn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Ua(e,t){let r=C(()=>z([tn(e),Ne(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function kn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(W(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),O(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),h(n,"mousedown").pipe(W(a),re(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Ie())==null||c.blur()}}),r.pipe(W(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Ua(e,t).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function Wa(e){return e.tagName==="CODE"?P(".c, .c1, .cm",e):[e]}function Da(e){let t=[];for(let r of Wa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function Hn(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Da(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,Tn(p,i)),s.replaceWith(a.get(p)))}return a.size===0?S:C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=[];for(let[l,f]of a)c.push([R(".md-typeset",f),R(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?Hn(f,u):Hn(u,f)}),O(...[...a].map(([,l])=>kn(l,t,{target$:r}))).pipe(_(()=>s.complete()),pe())})}function $n(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return $n(t)}}function Pn(e,t){return C(()=>{let r=$n(e);return typeof r!="undefined"?fr(r,e,t):S})}var Rn=Mt(Br());var Va=0;function In(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return In(t)}}function Na(e){return ge(e).pipe(m(({width:t})=>({scrollable:St(e).width>t})),ee("scrollable"))}function jn(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(jr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Rn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Va++}`;let l=Sn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(mt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=In(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(W(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:S)))}}return P(":scope > span[id]",e).length&&e.classList.add("md-code__content"),Na(e).pipe(w(c=>n.next(c)),_(()=>n.complete()),m(c=>$({ref:e},c)),Re(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function za(e,{target$:t,print$:r}){let o=!0;return O(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),w(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Fn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),za(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}var Un=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Gr,Qa=0;function Ka(){return typeof mermaid=="undefined"||mermaid instanceof Element?Tt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):I(void 0)}function Wn(e){return e.classList.remove("mermaid"),Gr||(Gr=Ka().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Un,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Gr.subscribe(()=>co(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Qa++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Gr.pipe(m(()=>({ref:e})))}var Dn=x("table");function Vn(e){return e.replaceWith(Dn),Dn.replaceWith(An(e)),I({ref:e})}function Ya(e){let t=e.find(r=>r.checked)||e[0];return O(...e.map(r=>h(r,"change").pipe(m(()=>R(`label[for="${r.id}"]`))))).pipe(Q(R(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Nn(e,{viewport$:t,target$:r}){let o=R(".tabbed-labels",e),n=P(":scope > input",e),i=Kr("prev");e.append(i);let a=Kr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(Z(),ie(!0));z([s,ge(e),tt(e)]).pipe(W(p),Me(1,me)).subscribe({next([{active:c},l]){let f=Ve(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=pr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ne(o),ge(o)]).pipe(W(p)).subscribe(([c,l])=>{let f=St(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),O(h(i,"click").pipe(m(()=>-1)),h(a,"click").pipe(m(()=>1))).pipe(W(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(W(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=R(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(p),b(f=>!(f.metaKey||f.ctrlKey)),w(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),re(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let y of P("[data-tabs]"))for(let L of P(":scope > input",y)){let X=R(`label[for="${L.id}"]`);if(X!==c&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),L.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),s.pipe(W(p)).subscribe(()=>{for(let c of P("audio, video",e))c.pause()}),Ya(n).pipe(w(c=>s.next(c)),_(()=>s.complete()),m(c=>$({ref:e},c)))}).pipe(Ke(se))}function zn(e,{viewport$:t,target$:r,print$:o}){return O(...P(".annotate:not(.highlight)",e).map(n=>Pn(n,{target$:r,print$:o})),...P("pre:not(.mermaid) > code",e).map(n=>jn(n,{target$:r,print$:o})),...P("pre.mermaid",e).map(n=>Wn(n)),...P("table:not([class])",e).map(n=>Vn(n)),...P("details",e).map(n=>Fn(n,{target$:r,print$:o})),...P("[data-tabs]",e).map(n=>Nn(n,{viewport$:t,target$:r})),...P("[title]",e).filter(()=>B("content.tooltips")).map(n=>mt(n,{viewport$:t})))}function Ba(e,{alert$:t}){return t.pipe(v(r=>O(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function qn(e,t){let r=R(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ba(e,t).pipe(w(n=>o.next(n)),_(()=>o.complete()),m(n=>$({ref:e},n)))})}var Ga=0;function Ja(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?Ne(o):I({x:0,y:0}),i=O(et(t),$t(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ve(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Qn(e){let t=e.title;if(!t.length)return S;let r=`__tooltip_${Ga++}`,o=Rt(r,"inline"),n=R(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),O(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ja(o,e).pipe(w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))}).pipe(Ke(se))}function Xa({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Be(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=ze("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Kn(e,t){return C(()=>z([ge(e),Xa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function Yn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(Z(),ie(!0));o.pipe(ee("active"),He(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue(P("[title]",e)).pipe(b(()=>B("content.tooltips")),ne(a=>Qn(a)));return r.subscribe(o),t.pipe(W(n),m(a=>$({ref:e},a)),Re(i.pipe(W(n))))})}function Za(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),ee("active"))}function Bn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?S:Za(o,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))})}function Gn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ee("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function es(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(ne(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Jn(e){let t=P("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Pt("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),re(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(ve(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),es(t).pipe(W(n.pipe(Ce(1))),ct(),w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))})}function Xn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(w(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Jr=Mt(Br());function ts(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Zn({alert$:e}){Jr.default.isSupported()&&new j(t=>{new Jr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ts(R(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function ei(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function rs(e,t){let r=new Map;for(let o of P("url",e)){let n=R("loc",o),i=[ei(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(ei(new URL(s),t))}}return r}function ur(e){return un(new URL("sitemap.xml",e)).pipe(m(t=>rs(t,new URL(e))),de(()=>I(new Map)))}function os(e,t){if(!(e.target instanceof Element))return S;let r=e.target.closest("a");if(r===null)return S;if(r.target||e.metaKey||e.ctrlKey)return S;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):S}function ti(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function ri(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function ns(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=ti(document);for(let[o,n]of ti(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return We(P("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),S}),Z(),ie(document))}function oi({location$:e,viewport$:t,progress$:r}){let o=xe();if(location.protocol==="file:")return S;let n=ur(o.base);I(document).subscribe(ri);let i=h(document.body,"click").pipe(He(n),v(([p,c])=>os(p,c)),pe()),a=h(window,"popstate").pipe(m(ye),pe());i.pipe(re(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),O(i,a).subscribe(e);let s=e.pipe(ee("pathname"),v(p=>fn(p,{progress$:r}).pipe(de(()=>(lt(p,!0),S)))),v(ri),v(ns),pe());return O(s.pipe(re(e,(p,c)=>c)),s.pipe(v(()=>e),ee("pathname"),v(()=>e),ee("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),w(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",pn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(ee("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ni=Mt(qr());function ii(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ni.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function jt(e){return e.type===1}function dr(e){return e.type===3}function ai(e,t){let r=yn(e);return O(I(location.protocol!=="file:"),ze("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function si(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=Xr(n))==null?void 0:l.pathname;if(i===void 0)return;let a=ss(o.pathname,i);if(a===void 0)return;let s=ps(t.keys());if(!t.has(s))return;let p=Xr(a,s);if(!p||!t.has(p.href))return;let c=Xr(a,r);if(c)return c.hash=o.hash,c.search=o.search,c}function Xr(e,t){try{return new URL(e,t)}catch(r){return}}function ss(e,t){if(e.startsWith(t))return e.slice(t.length)}function cs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oS)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),re(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?S:(i.preventDefault(),I(new URL(p)))}}return S}),v(i=>ur(i).pipe(m(a=>{var s;return(s=si({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:ye(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(n=>lt(n,!0)),z([r,o]).subscribe(([n,i])=>{R(".md-header__topic").appendChild(Cn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ls(e,{worker$:t}){let{searchParams:r}=ye();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),ze("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=ye();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=O(t.pipe(Ae(jt)),h(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function pi(e,{worker$:t}){let r=new g,o=r.pipe(Z(),ie(!0));z([t.pipe(Ae(jt)),r],(i,a)=>a).pipe(ee("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ee("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=R("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ls(e,{worker$:t}).pipe(w(i=>r.next(i)),_(()=>r.complete()),m(i=>$({ref:e},i)),G(1))}function li(e,{worker$:t,query$:r}){let o=new g,n=on(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=R(":scope > :first-child",e),s=R(":scope > :last-child",e);ze("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(re(r),Wr(t.pipe(Ae(jt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(w(()=>s.innerHTML=""),v(({items:l})=>O(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Be(4),Vr(n),v(([f])=>f)))),m(Mn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(ne(l=>{let f=fe("details",l);return typeof f=="undefined"?S:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(w(l=>o.next(l)),_(()=>o.complete()),m(l=>$({ref:e},l)))}function ms(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ye();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function mi(e,t){let r=new g,o=r.pipe(Z(),ie(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),ms(e,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))}function fi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=O(h(n,"keydown"),h(n,"focus")).pipe(ve(se),m(()=>n.value),K());return o.pipe(He(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(w(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ui(e,{index$:t,keyboard$:r}){let o=xe();try{let n=ai(o.search,t),i=Se("search-query",e),a=Se("search-result",e);h(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Ie();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of P(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...P(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Ie()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=pi(i,{worker$:n});return O(s,li(a,{worker$:n,query$:s})).pipe(Re(...ae("search-share",e).map(p=>mi(p,{query$:s})),...ae("search-suggest",e).map(p=>fi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ye}}function di(e,{index$:t,location$:r}){return z([t,r.pipe(Q(ye()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>ii(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function fs(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Zr(e,o){var n=o,{header$:t}=n,r=so(n,["header$"]);let i=R(".md-sidebar__scrollwrap",e),{y:a}=Ve(i);return C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=s.pipe(Me(0,me));return c.pipe(re(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of P(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2})}}}),ue(P("label[tabindex]",e)).pipe(ne(l=>h(l,"click").pipe(ve(se),m(()=>l),W(p)))).subscribe(l=>{let f=R(`[id="${l.htmlFor}"]`);R(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),fs(e,r).pipe(w(l=>s.next(l)),_(()=>s.complete()),m(l=>$({ref:e},l)))})}function hi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return st(je(`${r}/releases/latest`).pipe(de(()=>S),m(o=>({version:o.tag_name})),De({})),je(r).pipe(de(()=>S),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return je(r).pipe(m(o=>({repositories:o.public_repos})),De({}))}}function bi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return st(je(`${r}/releases/permalink/latest`).pipe(de(()=>S),m(({tag_name:o})=>({version:o})),De({})),je(r).pipe(de(()=>S),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}function vi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return hi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return bi(r,o)}return S}var us;function ds(e){return us||(us=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return S}return vi(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(de(()=>S),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function gi(e){let t=R(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(_n(o)),t.classList.add("md-source__repository--active")}),ds(e).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function hs(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ee("hidden"))}function yi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):hs(e,t)).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function bs(e,{viewport$:t,header$:r}){let o=new Map,n=P(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(ee("height"),m(({height:s})=>{let p=Se("main"),c=R(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(ee("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),He(i),v(([p,c])=>t.pipe(Fr(([l,f],{offset:{y:u},size:d})=>{let y=u+d.height>=Math.floor(s.height);for(;f.length;){let[,L]=f[0];if(L-c=u&&!y)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Be(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(Z(),ie(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=O(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),He(o.pipe(ve(se))),re(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(W(a),ee("offset"),_e(250),Ce(1),W(n.pipe(Ce(1))),ct({delay:250}),re(i)).subscribe(([,{prev:s}])=>{let p=ye(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),bs(e,{viewport$:t,header$:r}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function vs(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Be(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),W(o.pipe(Ce(1))),ie(!0),ct({delay:250}),m(a=>({hidden:a})))}function Ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(a),ee("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),h(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),vs(e,{viewport$:t,main$:o,target$:n}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))}function wi({document$:e,viewport$:t}){e.pipe(v(()=>P(".md-ellipsis")),ne(r=>tt(r).pipe(W(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?mt(n,{viewport$:t}).pipe(W(e.pipe(Ce(1))),_(()=>n.removeAttribute("title"))):S})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>P(".md-status")),ne(r=>mt(r,{viewport$:t}))).subscribe()}function Ti({document$:e,tablet$:t}){e.pipe(v(()=>P(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),ne(r=>h(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),re(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function gs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Si({document$:e}){e.pipe(v(()=>P("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),b(gs),ne(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Oi({viewport$:e,tablet$:t}){z([ze("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),re(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ys(){return location.protocol==="file:"?Tt(`${new URL("search/search_index.js",eo.base)}`).pipe(m(()=>__index),G(1)):je(new URL("search/search_index.json",eo.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Go(),Ut=sn(),Lt=ln(Ut),to=an(),Oe=gn(),hr=Pt("(min-width: 960px)"),Mi=Pt("(min-width: 1220px)"),_i=mn(),eo=xe(),Ai=document.forms.namedItem("search")?ys():Ye,ro=new g;Zn({alert$:ro});var oo=new g;B("navigation.instant")&&oi({location$:Ut,viewport$:Oe,progress$:oo}).subscribe(ot);var Li;((Li=eo.version)==null?void 0:Li.provider)==="mike"&&ci({document$:ot});O(Ut,Lt).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});to.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&<(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&<(r);break;case"Enter":let o=Ie();o instanceof HTMLLabelElement&&o.click()}});wi({viewport$:Oe,document$:ot});Ti({document$:ot,tablet$:hr});Si({document$:ot});Oi({viewport$:Oe,tablet$:hr});var rt=Kn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Gn(e,{viewport$:Oe,header$:rt})),G(1)),xs=O(...ae("consent").map(e=>En(e,{target$:Lt})),...ae("dialog").map(e=>qn(e,{alert$:ro})),...ae("palette").map(e=>Jn(e)),...ae("progress").map(e=>Xn(e,{progress$:oo})),...ae("search").map(e=>ui(e,{index$:Ai,keyboard$:to})),...ae("source").map(e=>gi(e))),Es=C(()=>O(...ae("announce").map(e=>xn(e)),...ae("content").map(e=>zn(e,{viewport$:Oe,target$:Lt,print$:_i})),...ae("content").map(e=>B("search.highlight")?di(e,{index$:Ai,location$:Ut}):S),...ae("header").map(e=>Yn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("header-title").map(e=>Bn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Mi,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>yi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>xi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})),...ae("top").map(e=>Ei(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})))),Ci=ot.pipe(v(()=>Es),Re(xs),G(1));Ci.subscribe();window.document$=ot;window.location$=Ut;window.target$=Lt;window.keyboard$=to;window.viewport$=Oe;window.tablet$=hr;window.screen$=Mi;window.print$=_i;window.alert$=ro;window.progress$=oo;window.component$=Ci;})(); +//# sourceMappingURL=bundle.83f73b43.min.js.map + diff --git a/html/site/assets/javascripts/bundle.83f73b43.min.js.map b/html/site/assets/javascripts/bundle.83f73b43.min.js.map new file mode 100644 index 0000000000..fe920b7d6e --- /dev/null +++ b/html/site/assets/javascripts/bundle.83f73b43.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
    \n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an